API Documentation
Basics ¶
Rechat’s responses follow a set of conventions which are described below.
-
All responses are JSON formatted.
-
All responses are Objects.
-
All responses have a
code. -
If the operation has been successfull then
code = 'OK'
Errors ¶
All errors will have a:
-
codethat explains the error, -
A
messagethat gives some information about the error
Example Error ¶
Example ErrorGET/rooms/:id
Example URI
GET /rooms/:id
URI Parameters
- id
string(required) Example: 85c92240-c4d7-11f1-822f-779c5bc5dcca
Response
404Body
{
"trace": false,
"http": 404,
"message": "Room 85c92240-c4d7-11f1-822f-779c5bc5dcca not found",
"code": "ResourceNotFound",
"slack": false
}Format ¶
Single Entities
If the called endpoint is supposed to provide a single entity, the entity will be stored in data key.
Collections
If the called endpoint is supposed to provide a collection of entities,
the data key will be an array of all retrieved entities.
An info object will also be provided that includes:
-
countThe number of retrieved entities that are present in thedata -
totalTotal number of matching entities which coule be fetched using pagination
Example single entity endpoint ¶
Example single entity endpointGET/rooms/:id
Example URI
GET /rooms/:id
URI Parameters
- id
string(required) Example: 735db31f-5006-49c2-a5f0-81fb38c339bb- associations
string(required) Example: room.owner,room.latest_message,room.users
Response
200Body
{
"code": "OK",
"data": {
"type": "room",
"id": "735db31f-5006-49c2-a5f0-81fb38c339bb",
"title": "sampleroom",
"owner": {
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17038213223",
"created_at": 1791656536.209472,
"id": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.209491,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "b4993399-7221-4f32-a739-4510efc4fb7f",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
},
"created_at": 1791656536.361677,
"updated_at": 1791656536.433522,
"deleted_at": null,
"room_type": "Group",
"new_notifications": 0,
"latest_message": {
"type": "message",
"mid": "48e7d451-5929-4c74-813f-6f342b329b3a",
"id": "48e7d451-5929-4c74-813f-6f342b329b3a",
"comment": "John invited +18598161689 to join.",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": null,
"created_at": 1791656536.433522,
"updated_at": 1791656536.433522,
"room": "735db31f-5006-49c2-a5f0-81fb38c339bb",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": {
"type": "notification",
"id": "2a7d7963-ea46-4248-bfe2-a9d29b3b1926",
"object": "735db31f-5006-49c2-a5f0-81fb38c339bb",
"message": "John invited +18598161689 to join.",
"created_at": 1791656536.429965,
"updated_at": 1791656536.429965,
"room": "735db31f-5006-49c2-a5f0-81fb38c339bb",
"action": "Invited",
"object_class": "Room",
"subject": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf",
"auxiliary_object_class": "User",
"auxiliary_object": {
"type": "user",
"username": null,
"first_name": "",
"last_name": "",
"email": "[email protected]",
"phone_number": "+18598161689",
"created_at": 1791656536.349459,
"id": "a884856b-472f-4381-9c85-ab207588398e",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.349463,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Client",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": true,
"personal_room": "c2b5a291-cf4a-4d08-af53-4e5a4c5fc97f",
"brand": null,
"fake_email": true,
"features": null,
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": null,
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "+18598161689",
"abbreviated_display_name": "+18598161689",
"online_state": "Offline",
"has_password": false
},
"recommendation": null,
"auxiliary_subject": null,
"subject_class": "User",
"auxiliary_subject_class": null,
"extra_subject_class": null,
"extra_object_class": null,
"deleted_at": null,
"specific": null,
"title": null,
"data": null,
"sound": null,
"app": "rechat",
"transports": null,
"phone_number": null,
"notification_type": "UserInvitedRoom",
"seen": true,
"recommendations": null,
"objects": null,
"subjects": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17038213223",
"created_at": 1791656536.209472,
"id": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.209491,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "b4993399-7221-4f32-a739-4510efc4fb7f",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
]
},
"reference": null,
"mentions": null,
"activity": null,
"role": null,
"attachments": [],
"files": null,
"email_campaigns": null,
"contacts": null,
"crm_tasks": null,
"compact_listings": null,
"input_forms": null,
"artifacts": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": [
{
"user": "a884856b-472f-4381-9c85-ab207588398e",
"delivery_type": "sms",
"type": "notification_delivery",
"created_at": "2026-10-10T18:22:16.489408+00:00"
}
]
},
"notification_settings": {
"a250c267-e8bb-4ef3-ba83-5e4f5e438ecf": "N_ALL"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17038213223",
"created_at": 1791656536.209472,
"id": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.209491,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "b4993399-7221-4f32-a739-4510efc4fb7f",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
},
{
"type": "user",
"username": null,
"first_name": "",
"last_name": "",
"email": "[email protected]",
"phone_number": "+18598161689",
"created_at": 1791656536.349459,
"id": "a884856b-472f-4381-9c85-ab207588398e",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.349463,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Client",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": true,
"personal_room": "c2b5a291-cf4a-4d08-af53-4e5a4c5fc97f",
"brand": null,
"fake_email": true,
"features": null,
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": null,
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "+18598161689",
"abbreviated_display_name": "+18598161689",
"online_state": "Offline",
"has_password": false
},
{
"type": "user",
"username": null,
"first_name": "[email protected]",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1791656536.348933,
"id": "d9f0ef2b-1dcf-4cee-ae66-7a0de2c70476",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.348939,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Client",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": true,
"personal_room": "c401c766-e4a6-4e3e-9415-5668a356c534",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": null,
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "[email protected] ",
"abbreviated_display_name": "[email protected]",
"online_state": "Offline",
"has_password": false
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "[email protected], +18598161689"
}
}Example collection endpoint ¶
Example collection endpointGET/rooms
Example URI
GET /rooms
URI Parameters
- associations
string(required) Example: room.owner,room.latest_message,room.users
Response
200Body
{
"code": "OK",
"data": [
{
"type": "room",
"id": "a352a69c-8454-4738-8e08-c60436af7d6d",
"title": null,
"owner": null,
"created_at": 1791656536.542164,
"updated_at": 1791656536.554521,
"deleted_at": null,
"room_type": "Direct",
"new_notifications": 0,
"latest_message": {
"type": "message",
"mid": "8668ea60-4220-4cf2-bcce-454c9663867f",
"id": "8668ea60-4220-4cf2-bcce-454c9663867f",
"comment": "John invited [email protected] to join.",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": null,
"created_at": 1791656536.554521,
"updated_at": 1791656536.554521,
"room": "a352a69c-8454-4738-8e08-c60436af7d6d",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": {
"type": "notification",
"id": "7f5b5242-acad-4781-883a-8d985e241c9e",
"object": "a352a69c-8454-4738-8e08-c60436af7d6d",
"message": "John invited [email protected] to join.",
"created_at": 1791656536.551037,
"updated_at": 1791656536.551037,
"room": "a352a69c-8454-4738-8e08-c60436af7d6d",
"action": "Invited",
"object_class": "Room",
"subject": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf",
"auxiliary_object_class": "User",
"auxiliary_object": {
"type": "user",
"username": null,
"first_name": "[email protected]",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1791656536.531659,
"id": "36e2dd28-a2b2-4c1c-a39f-ed12846d3a8a",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.531667,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Client",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": true,
"personal_room": "6192e447-e46f-4967-ae75-faf639c3364a",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": null,
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "[email protected] ",
"abbreviated_display_name": "[email protected]",
"online_state": "Offline",
"has_password": false
},
"recommendation": null,
"auxiliary_subject": null,
"subject_class": "User",
"auxiliary_subject_class": null,
"extra_subject_class": null,
"extra_object_class": null,
"deleted_at": null,
"specific": null,
"title": null,
"data": null,
"sound": null,
"app": "rechat",
"transports": null,
"phone_number": null,
"notification_type": "UserInvitedRoom",
"seen": true,
"recommendations": null,
"objects": null,
"subjects": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17038213223",
"created_at": 1791656536.209472,
"id": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.209491,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "b4993399-7221-4f32-a739-4510efc4fb7f",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
]
},
"reference": null,
"mentions": null,
"activity": null,
"role": null,
"attachments": [],
"files": null,
"email_campaigns": null,
"contacts": null,
"crm_tasks": null,
"compact_listings": null,
"input_forms": null,
"artifacts": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": null
},
"notification_settings": {
"a250c267-e8bb-4ef3-ba83-5e4f5e438ecf": "N_ALL"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "[email protected]",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1791656536.531659,
"id": "36e2dd28-a2b2-4c1c-a39f-ed12846d3a8a",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.531667,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Client",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": true,
"personal_room": "6192e447-e46f-4967-ae75-faf639c3364a",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": null,
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "[email protected] ",
"abbreviated_display_name": "[email protected]",
"online_state": "Offline",
"has_password": false
},
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17038213223",
"created_at": 1791656536.209472,
"id": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.209491,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "b4993399-7221-4f32-a739-4510efc4fb7f",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "[email protected]"
},
{
"type": "room",
"id": "735db31f-5006-49c2-a5f0-81fb38c339bb",
"title": "sampleroom",
"owner": {
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17038213223",
"created_at": 1791656536.209472,
"id": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.209491,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "b4993399-7221-4f32-a739-4510efc4fb7f",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
},
"created_at": 1791656536.361677,
"updated_at": 1791656536.433522,
"deleted_at": null,
"room_type": "Group",
"new_notifications": 0,
"latest_message": {
"type": "message",
"mid": "48e7d451-5929-4c74-813f-6f342b329b3a",
"id": "48e7d451-5929-4c74-813f-6f342b329b3a",
"comment": "John invited +18598161689 to join.",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": null,
"created_at": 1791656536.433522,
"updated_at": 1791656536.433522,
"room": "735db31f-5006-49c2-a5f0-81fb38c339bb",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": {
"type": "notification",
"id": "2a7d7963-ea46-4248-bfe2-a9d29b3b1926",
"object": "735db31f-5006-49c2-a5f0-81fb38c339bb",
"message": "John invited +18598161689 to join.",
"created_at": 1791656536.429965,
"updated_at": 1791656536.429965,
"room": "735db31f-5006-49c2-a5f0-81fb38c339bb",
"action": "Invited",
"object_class": "Room",
"subject": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf",
"auxiliary_object_class": "User",
"auxiliary_object": {
"type": "user",
"username": null,
"first_name": "",
"last_name": "",
"email": "[email protected]",
"phone_number": "+18598161689",
"created_at": 1791656536.349459,
"id": "a884856b-472f-4381-9c85-ab207588398e",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.349463,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Client",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": true,
"personal_room": "c2b5a291-cf4a-4d08-af53-4e5a4c5fc97f",
"brand": null,
"fake_email": true,
"features": null,
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": null,
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "+18598161689",
"abbreviated_display_name": "+18598161689",
"online_state": "Offline",
"has_password": false
},
"recommendation": null,
"auxiliary_subject": null,
"subject_class": "User",
"auxiliary_subject_class": null,
"extra_subject_class": null,
"extra_object_class": null,
"deleted_at": null,
"specific": null,
"title": null,
"data": null,
"sound": null,
"app": "rechat",
"transports": null,
"phone_number": null,
"notification_type": "UserInvitedRoom",
"seen": true,
"recommendations": null,
"objects": null,
"subjects": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17038213223",
"created_at": 1791656536.209472,
"id": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.209491,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "b4993399-7221-4f32-a739-4510efc4fb7f",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
]
},
"reference": null,
"mentions": null,
"activity": null,
"role": null,
"attachments": [],
"files": null,
"email_campaigns": null,
"contacts": null,
"crm_tasks": null,
"compact_listings": null,
"input_forms": null,
"artifacts": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": [
{
"user": "a884856b-472f-4381-9c85-ab207588398e",
"delivery_type": "sms",
"type": "notification_delivery",
"created_at": "2026-10-10T18:22:16.489408+00:00"
}
]
},
"notification_settings": {
"a250c267-e8bb-4ef3-ba83-5e4f5e438ecf": "N_ALL"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17038213223",
"created_at": 1791656536.209472,
"id": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.209491,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "b4993399-7221-4f32-a739-4510efc4fb7f",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
},
{
"type": "user",
"username": null,
"first_name": "",
"last_name": "",
"email": "[email protected]",
"phone_number": "+18598161689",
"created_at": 1791656536.349459,
"id": "a884856b-472f-4381-9c85-ab207588398e",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.349463,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Client",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": true,
"personal_room": "c2b5a291-cf4a-4d08-af53-4e5a4c5fc97f",
"brand": null,
"fake_email": true,
"features": null,
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": null,
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "+18598161689",
"abbreviated_display_name": "+18598161689",
"online_state": "Offline",
"has_password": false
},
{
"type": "user",
"username": null,
"first_name": "[email protected]",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1791656536.348933,
"id": "d9f0ef2b-1dcf-4cee-ae66-7a0de2c70476",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.348939,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Client",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": true,
"personal_room": "c401c766-e4a6-4e3e-9415-5668a356c534",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": null,
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "[email protected] ",
"abbreviated_display_name": "[email protected]",
"online_state": "Offline",
"has_password": false
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "[email protected], +18598161689"
}
],
"info": {
"count": 2,
"total": 2,
"new": 0
}
}Associations ¶
Rechat is heavily relational and the need to have access to the associations within an object.
There are two formats that are supported.
-
Nested (default, legacy). All entities are already deeply nested in this format. But the response size could be too big.
-
Referenced. (prefered). Data objects are not nested but the response is compact.
Nested responses
Nested responses are considered harmful. They are only being used for backward compatibility reasons.
A nested example looks like this:
{
code: 'OK',
data: {
id: 1,
type: 'room'
owner: {
id: 1,
type: 'user',
email: '[email protected]'
},
users: [
{
id: 1,
type: 'user',
email: '[email protected]'
},
{
id: 2,
type: 'user',
email: '[email protected]'
}
],
latest_message: {
id: 1,
comment: 'Hi',
author: {
id: 1,
type: 'user',
email: '[email protected]'
}
}
}
}As you can see in the object above, User #1 is the owner of the room and author of the latest message. He is also one of the members of the room.
Therefore, his user object is repeated 3 times and thus, inflating the response.
Referenced
Provide the following header:
X-RECHAT-FORMAT: referencesAnd the response format you’ll get the following format:
{
code: 'OK',
references: {
user: {
1: {
id: 1,
type: 'user',
email: '[email protected]'
},
2: {
id: 2,
type: 'user',
email: '[email protected]'
}
},
message: {
1: {
id: 1,
comment: 'Hi',
author: {
type: 'reference',
model: 'user',
id:1,
}
}
}
}
data: {
id: 1,
type: 'room'
owner: ,
users: [
{
type: 'reference',
model: 'user',
id:1,
},
{
type: 'reference',
model: 'user',
id:2,
}
]
latest_message: {
type: 'reference',
model: 'message',
id: 1
}
}
}The advantage to this format is that no matter how many times we repeat user #1 (or any other entity)
the response size will not grow a lot.
Example nested responsed ¶
Example nested responsedGET/rooms
Example URI
GET /rooms
URI Parameters
- associations
string(required) Example: room.owner,room.latest_message,room.users
Response
200Body
{
"code": "OK",
"data": [
{
"type": "room",
"id": "a352a69c-8454-4738-8e08-c60436af7d6d",
"title": null,
"owner": null,
"created_at": 1791656536.542164,
"updated_at": 1791656536.554521,
"deleted_at": null,
"room_type": "Direct",
"new_notifications": 0,
"latest_message": {
"type": "message",
"mid": "8668ea60-4220-4cf2-bcce-454c9663867f",
"id": "8668ea60-4220-4cf2-bcce-454c9663867f",
"comment": "John invited [email protected] to join.",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": null,
"created_at": 1791656536.554521,
"updated_at": 1791656536.554521,
"room": "a352a69c-8454-4738-8e08-c60436af7d6d",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": {
"type": "notification",
"id": "7f5b5242-acad-4781-883a-8d985e241c9e",
"object": "a352a69c-8454-4738-8e08-c60436af7d6d",
"message": "John invited [email protected] to join.",
"created_at": 1791656536.551037,
"updated_at": 1791656536.551037,
"room": "a352a69c-8454-4738-8e08-c60436af7d6d",
"action": "Invited",
"object_class": "Room",
"subject": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf",
"auxiliary_object_class": "User",
"auxiliary_object": {
"type": "user",
"username": null,
"first_name": "[email protected]",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1791656536.531659,
"id": "36e2dd28-a2b2-4c1c-a39f-ed12846d3a8a",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.531667,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Client",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": true,
"personal_room": "6192e447-e46f-4967-ae75-faf639c3364a",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": null,
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "[email protected] ",
"abbreviated_display_name": "[email protected]",
"online_state": "Offline",
"has_password": false
},
"recommendation": null,
"auxiliary_subject": null,
"subject_class": "User",
"auxiliary_subject_class": null,
"extra_subject_class": null,
"extra_object_class": null,
"deleted_at": null,
"specific": null,
"title": null,
"data": null,
"sound": null,
"app": "rechat",
"transports": null,
"phone_number": null,
"notification_type": "UserInvitedRoom",
"seen": true,
"recommendations": null,
"objects": null,
"subjects": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17038213223",
"created_at": 1791656536.209472,
"id": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.209491,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "b4993399-7221-4f32-a739-4510efc4fb7f",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
]
},
"reference": null,
"mentions": null,
"activity": null,
"role": null,
"attachments": [],
"files": null,
"email_campaigns": null,
"contacts": null,
"crm_tasks": null,
"compact_listings": null,
"input_forms": null,
"artifacts": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": null
},
"notification_settings": {
"a250c267-e8bb-4ef3-ba83-5e4f5e438ecf": "N_ALL"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "[email protected]",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1791656536.531659,
"id": "36e2dd28-a2b2-4c1c-a39f-ed12846d3a8a",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.531667,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Client",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": true,
"personal_room": "6192e447-e46f-4967-ae75-faf639c3364a",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": null,
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "[email protected] ",
"abbreviated_display_name": "[email protected]",
"online_state": "Offline",
"has_password": false
},
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17038213223",
"created_at": 1791656536.209472,
"id": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.209491,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "b4993399-7221-4f32-a739-4510efc4fb7f",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "[email protected]"
},
{
"type": "room",
"id": "735db31f-5006-49c2-a5f0-81fb38c339bb",
"title": "sampleroom",
"owner": {
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17038213223",
"created_at": 1791656536.209472,
"id": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.209491,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "b4993399-7221-4f32-a739-4510efc4fb7f",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
},
"created_at": 1791656536.361677,
"updated_at": 1791656536.433522,
"deleted_at": null,
"room_type": "Group",
"new_notifications": 0,
"latest_message": {
"type": "message",
"mid": "48e7d451-5929-4c74-813f-6f342b329b3a",
"id": "48e7d451-5929-4c74-813f-6f342b329b3a",
"comment": "John invited +18598161689 to join.",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": null,
"created_at": 1791656536.433522,
"updated_at": 1791656536.433522,
"room": "735db31f-5006-49c2-a5f0-81fb38c339bb",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": {
"type": "notification",
"id": "2a7d7963-ea46-4248-bfe2-a9d29b3b1926",
"object": "735db31f-5006-49c2-a5f0-81fb38c339bb",
"message": "John invited +18598161689 to join.",
"created_at": 1791656536.429965,
"updated_at": 1791656536.429965,
"room": "735db31f-5006-49c2-a5f0-81fb38c339bb",
"action": "Invited",
"object_class": "Room",
"subject": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf",
"auxiliary_object_class": "User",
"auxiliary_object": {
"type": "user",
"username": null,
"first_name": "",
"last_name": "",
"email": "[email protected]",
"phone_number": "+18598161689",
"created_at": 1791656536.349459,
"id": "a884856b-472f-4381-9c85-ab207588398e",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.349463,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Client",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": true,
"personal_room": "c2b5a291-cf4a-4d08-af53-4e5a4c5fc97f",
"brand": null,
"fake_email": true,
"features": null,
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": null,
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "+18598161689",
"abbreviated_display_name": "+18598161689",
"online_state": "Offline",
"has_password": false
},
"recommendation": null,
"auxiliary_subject": null,
"subject_class": "User",
"auxiliary_subject_class": null,
"extra_subject_class": null,
"extra_object_class": null,
"deleted_at": null,
"specific": null,
"title": null,
"data": null,
"sound": null,
"app": "rechat",
"transports": null,
"phone_number": null,
"notification_type": "UserInvitedRoom",
"seen": true,
"recommendations": null,
"objects": null,
"subjects": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17038213223",
"created_at": 1791656536.209472,
"id": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.209491,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "b4993399-7221-4f32-a739-4510efc4fb7f",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
]
},
"reference": null,
"mentions": null,
"activity": null,
"role": null,
"attachments": [],
"files": null,
"email_campaigns": null,
"contacts": null,
"crm_tasks": null,
"compact_listings": null,
"input_forms": null,
"artifacts": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": [
{
"user": "a884856b-472f-4381-9c85-ab207588398e",
"delivery_type": "sms",
"type": "notification_delivery",
"created_at": "2026-10-10T18:22:16.489408+00:00"
}
]
},
"notification_settings": {
"a250c267-e8bb-4ef3-ba83-5e4f5e438ecf": "N_ALL"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17038213223",
"created_at": 1791656536.209472,
"id": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.209491,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "b4993399-7221-4f32-a739-4510efc4fb7f",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
},
{
"type": "user",
"username": null,
"first_name": "",
"last_name": "",
"email": "[email protected]",
"phone_number": "+18598161689",
"created_at": 1791656536.349459,
"id": "a884856b-472f-4381-9c85-ab207588398e",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.349463,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Client",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": true,
"personal_room": "c2b5a291-cf4a-4d08-af53-4e5a4c5fc97f",
"brand": null,
"fake_email": true,
"features": null,
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": null,
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "+18598161689",
"abbreviated_display_name": "+18598161689",
"online_state": "Offline",
"has_password": false
},
{
"type": "user",
"username": null,
"first_name": "[email protected]",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1791656536.348933,
"id": "d9f0ef2b-1dcf-4cee-ae66-7a0de2c70476",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.348939,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Client",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": true,
"personal_room": "c401c766-e4a6-4e3e-9415-5668a356c534",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": null,
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "[email protected] ",
"abbreviated_display_name": "[email protected]",
"online_state": "Offline",
"has_password": false
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "[email protected], +18598161689"
}
],
"info": {
"count": 2,
"total": 2,
"new": 0
}
}Example referenced responsed ¶
Example referenced responsedGET/rooms
Example URI
GET /rooms
URI Parameters
- associations
string(required) Example: room.owner,room.latest_message,room.users
Response
200Body
{
"code": "OK",
"data": [
{
"type": "room",
"id": "a352a69c-8454-4738-8e08-c60436af7d6d",
"title": null,
"owner": null,
"created_at": 1791656536.542164,
"updated_at": 1791656536.554521,
"deleted_at": null,
"room_type": "Direct",
"new_notifications": 0,
"latest_message": {
"type": "reference",
"object_type": "message",
"id": "8668ea60-4220-4cf2-bcce-454c9663867f"
},
"notification_settings": {
"a250c267-e8bb-4ef3-ba83-5e4f5e438ecf": "N_ALL"
},
"users": [
{
"type": "reference",
"object_type": "user",
"id": "36e2dd28-a2b2-4c1c-a39f-ed12846d3a8a"
},
{
"type": "reference",
"object_type": "user",
"id": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf"
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "[email protected]"
},
{
"type": "room",
"id": "735db31f-5006-49c2-a5f0-81fb38c339bb",
"title": "sampleroom",
"owner": {
"type": "reference",
"object_type": "user",
"id": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf"
},
"created_at": 1791656536.361677,
"updated_at": 1791656536.433522,
"deleted_at": null,
"room_type": "Group",
"new_notifications": 0,
"latest_message": {
"type": "reference",
"object_type": "message",
"id": "48e7d451-5929-4c74-813f-6f342b329b3a"
},
"notification_settings": {
"a250c267-e8bb-4ef3-ba83-5e4f5e438ecf": "N_ALL"
},
"users": [
{
"type": "reference",
"object_type": "user",
"id": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf"
},
{
"type": "reference",
"object_type": "user",
"id": "a884856b-472f-4381-9c85-ab207588398e"
},
{
"type": "reference",
"object_type": "user",
"id": "d9f0ef2b-1dcf-4cee-ae66-7a0de2c70476"
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "[email protected], +18598161689"
}
],
"references": {
"user": {
"36e2dd28-a2b2-4c1c-a39f-ed12846d3a8a": {
"type": "user",
"username": null,
"first_name": "[email protected]",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1791656536.531659,
"id": "36e2dd28-a2b2-4c1c-a39f-ed12846d3a8a",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.531667,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Client",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": true,
"personal_room": "6192e447-e46f-4967-ae75-faf639c3364a",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": null,
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "[email protected] ",
"abbreviated_display_name": "[email protected]",
"online_state": "Offline",
"has_password": false
},
"a250c267-e8bb-4ef3-ba83-5e4f5e438ecf": {
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17038213223",
"created_at": 1791656536.209472,
"id": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.209491,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "b4993399-7221-4f32-a739-4510efc4fb7f",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
},
"a884856b-472f-4381-9c85-ab207588398e": {
"type": "user",
"username": null,
"first_name": "",
"last_name": "",
"email": "[email protected]",
"phone_number": "+18598161689",
"created_at": 1791656536.349459,
"id": "a884856b-472f-4381-9c85-ab207588398e",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.349463,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Client",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": true,
"personal_room": "c2b5a291-cf4a-4d08-af53-4e5a4c5fc97f",
"brand": null,
"fake_email": true,
"features": null,
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": null,
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "+18598161689",
"abbreviated_display_name": "+18598161689",
"online_state": "Offline",
"has_password": false
},
"d9f0ef2b-1dcf-4cee-ae66-7a0de2c70476": {
"type": "user",
"username": null,
"first_name": "[email protected]",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1791656536.348933,
"id": "d9f0ef2b-1dcf-4cee-ae66-7a0de2c70476",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656536.348939,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Client",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": true,
"personal_room": "c401c766-e4a6-4e3e-9415-5668a356c534",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": null,
"current_time": "1:22 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "[email protected] ",
"abbreviated_display_name": "[email protected]",
"online_state": "Offline",
"has_password": false
}
},
"message": {
"8668ea60-4220-4cf2-bcce-454c9663867f": {
"type": "message",
"mid": "8668ea60-4220-4cf2-bcce-454c9663867f",
"id": "8668ea60-4220-4cf2-bcce-454c9663867f",
"comment": "John invited [email protected] to join.",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": null,
"created_at": 1791656536.554521,
"updated_at": 1791656536.554521,
"room": "a352a69c-8454-4738-8e08-c60436af7d6d",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": {
"type": "reference",
"object_type": "notification",
"id": "7f5b5242-acad-4781-883a-8d985e241c9e"
},
"reference": null,
"mentions": null,
"activity": null,
"role": null,
"attachments": [],
"files": null,
"email_campaigns": null,
"contacts": null,
"crm_tasks": null,
"compact_listings": null,
"input_forms": null,
"artifacts": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": null
},
"48e7d451-5929-4c74-813f-6f342b329b3a": {
"type": "message",
"mid": "48e7d451-5929-4c74-813f-6f342b329b3a",
"id": "48e7d451-5929-4c74-813f-6f342b329b3a",
"comment": "John invited +18598161689 to join.",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": null,
"created_at": 1791656536.433522,
"updated_at": 1791656536.433522,
"room": "735db31f-5006-49c2-a5f0-81fb38c339bb",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": {
"type": "reference",
"object_type": "notification",
"id": "2a7d7963-ea46-4248-bfe2-a9d29b3b1926"
},
"reference": null,
"mentions": null,
"activity": null,
"role": null,
"attachments": [],
"files": null,
"email_campaigns": null,
"contacts": null,
"crm_tasks": null,
"compact_listings": null,
"input_forms": null,
"artifacts": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": [
{
"user": "a884856b-472f-4381-9c85-ab207588398e",
"delivery_type": "sms",
"type": "notification_delivery",
"created_at": "2026-10-10T18:22:16.489408+00:00"
}
]
}
},
"notification": {
"7f5b5242-acad-4781-883a-8d985e241c9e": {
"type": "notification",
"id": "7f5b5242-acad-4781-883a-8d985e241c9e",
"object": "a352a69c-8454-4738-8e08-c60436af7d6d",
"message": "John invited [email protected] to join.",
"created_at": 1791656536.551037,
"updated_at": 1791656536.551037,
"room": "a352a69c-8454-4738-8e08-c60436af7d6d",
"action": "Invited",
"object_class": "Room",
"subject": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf",
"auxiliary_object_class": "User",
"auxiliary_object": {
"type": "reference",
"object_type": "user",
"id": "36e2dd28-a2b2-4c1c-a39f-ed12846d3a8a"
},
"recommendation": null,
"auxiliary_subject": null,
"subject_class": "User",
"auxiliary_subject_class": null,
"extra_subject_class": null,
"extra_object_class": null,
"deleted_at": null,
"specific": null,
"title": null,
"data": null,
"sound": null,
"app": "rechat",
"transports": null,
"phone_number": null,
"notification_type": "UserInvitedRoom",
"seen": true,
"recommendations": null,
"objects": null,
"subjects": [
{
"type": "reference",
"object_type": "user",
"id": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf"
}
]
},
"2a7d7963-ea46-4248-bfe2-a9d29b3b1926": {
"type": "notification",
"id": "2a7d7963-ea46-4248-bfe2-a9d29b3b1926",
"object": "735db31f-5006-49c2-a5f0-81fb38c339bb",
"message": "John invited +18598161689 to join.",
"created_at": 1791656536.429965,
"updated_at": 1791656536.429965,
"room": "735db31f-5006-49c2-a5f0-81fb38c339bb",
"action": "Invited",
"object_class": "Room",
"subject": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf",
"auxiliary_object_class": "User",
"auxiliary_object": {
"type": "reference",
"object_type": "user",
"id": "a884856b-472f-4381-9c85-ab207588398e"
},
"recommendation": null,
"auxiliary_subject": null,
"subject_class": "User",
"auxiliary_subject_class": null,
"extra_subject_class": null,
"extra_object_class": null,
"deleted_at": null,
"specific": null,
"title": null,
"data": null,
"sound": null,
"app": "rechat",
"transports": null,
"phone_number": null,
"notification_type": "UserInvitedRoom",
"seen": true,
"recommendations": null,
"objects": null,
"subjects": [
{
"type": "reference",
"object_type": "user",
"id": "a250c267-e8bb-4ef3-ba83-5e4f5e438ecf"
}
]
}
}
},
"info": {
"count": 2,
"total": 2,
"new": 0
}
}