Data Types

API data types refer to the structure and format of the values sent and received in the API. These define how data should be formatted in your requests and how to interpret responses.

User

{
    "guid": "00000000-0000-0000-0000-000000000000",
    "email": "user@example.com",
    "firstname": "John",
    "lastname": "Doe",
    "phone": "",
    "image": null,
    "created_at": 1740236299,
    "updated_at": 1740236299,
    "company": null,
    "plan": "pro",
    "timezone": "Australia/Melbourne",
    "lang": "en"
}

Workspace

{
    "guid": "00000000-0000-0000-0000-000000000000",
    "is_agency": 1,
    "title": "Default",
    "description": null,
    "image": null,
    "logo": null,
    "created_at": 1709406616,
    "updated_at": 1749289952,
    "channels": [
        ...array of channels
    ]
}

Channel

{
     "guid": "00000000-0000-0000-0000-000000000000",
     "name": "Custom title",
     "class_name": "LiveChatWeb",
     "origin": null,
     "status": 1,
     "created_at": 1709406616,
     "image": null
}

Contact

{
    "guid": "00000000-0000-0000-0000-000000000000",
    "name": "John Doe",
    "email": "john@doe.com",
    "phone": null,
    "clean_phone": null,
    "zip_code": null,
    "country": "Australia",
    "city": null,
    "state": null,
    "address": null,
    "company": null,
    "lang": "pl",
    "timezone": "Australia/Melbourne",
    "source": "livechat",
    "source_id": "00000000-0000-0000-0000-000000000000",
    "assigned_to": null,
    "created_at": 1691000636,
    "updated_at": 1738683845,
    "image": null
}

Chat

{
    "guid": "00000000-0000-0000-0000-000000000000",
    "channel": "00000000-0000-0000-0000-000000000000",
    "started_by": "00000000-0000-0000-0000-000000000000",
    "assigned_to": "00000000-0000-0000-0000-000000000000",
    "is_closed": 0,
    "is_archive": 0,
    "notes": null,
    "created_at": 1643289274,
    "updated_at": 1748794808,
    "last_message_at": 1643301841,
    "is_group": 0,
    "title": null,
    "image": null,
    "mute": 0,
    "source": "livechat",
    "source_id": null,
    "contact": null
}

Message

{
    "id": 1645,
    "thread_guid": "00000000-0000-0000-0000-000000000000",
    "from_guid": "00000000-0000-0000-0000-000000000000",
    "is_bot": null,
    "is_service": 1,
    "message": "Hello there!",
    "created_at": 1643301841,
    "updated_at": 1643301841,
    "last_edit": 0,
    "source": "livechat",
    "source_id": null,
    "attachments": [
         ...array of message attachments
    ]
}

MessageAttachment

{
    "id": 37826,
    "thread": "00000000-0000-0000-0000-000000000000",
    "message_id": 538782,
    "filename": "filename.png",
    "url": "https://anc.hel1.your-objectstorage.com/storage/usr/rH-J-tOR1UqfQY/ws/a3uqg_Q2Op1lYeA/uploads/5WKySZYIq2wdse1213xFkDA9w.png",
    "filesize": 30913,
    "mime": "image/png",
    "created_at": 1749309528
}

TeamMember

{
    "guid": "00000000-0000-0000-0000-000000000000",
    "email": "john@doe.com",
    "firstname": "John",
    "lastname": "Doe",
    "phone": "",
    "image": null,
    "created_at": 1749234963,
    "updated_at": 1749234963,
    "timezone": "Australia/Melbourne",
    "lang": "en",
    "role": "owner"
}

Data Types

Related Articles