Get the chat configuration

The chat window's setup for an organization: the pre-chat form, and its widget settings under properties.mlivechat.

No token. GET with organization_id in the query, or POST it in the body.

GET/v1/customer/action/get_configuration

curl 'https://app.staging.mlive.chat/v1/customer/action/get_configuration?organization_id=8cc7b1ee-a0e4-7910-8500-c032c91d4754'

const res = await fetch('https://app.staging.mlive.chat/v1/customer/action/get_configuration?organization_id=8cc7b1ee-a0e4-7910-8500-c032c91d4754');
const data = await res.json();

Response200

{
  "buttons": [],
  "prechat_form": {
    "id": "prechat",
    "fields": [
      {
        "id": "f1",
        "type": "info",
        "label": "Tell us who you are and we will connect you with the right person.",
        "required": false
      },
      {
        "id": "f2",
        "type": "name",
        "label": "Name",
        "required": false
      },
      {
        "id": "f3",
        "type": "email",
        "label": "Email",
        "required": true
      }
    ]
  },
  "integrations": {},
  "properties": {
    "mlivechat": {
      "name": "Northwind Outfitters",
      "group_id": 0,
      "online": true,
      "widget": {
        "color": "#1857f6",
        "position": "right",
        "greeting": "Hi! Any questions? We're here to help.",
        "show_greeting": true,
        "agent_photo": true,
        "privacy_url": "https://northwind.example/privacy"
      },
      "prechat_enabled": true,
      "postchat": {
        "enabled": true,
        "rating_label": "How would you rate this chat?",
        "comment_label": "Tell us more (optional)",
        "thanks": "Thanks for chatting with us."
      },
      "agent": {
        "id": "01937c6e-0000-7000-8000-0000000000a7",
        "name": "Maya Chen",
        "job_title": "Support",
        "avatar_url": null,
        "type": "human"
      }
    }
  }
}

Specifics

Method URL	`GET https://app.staging.mlive.chat/v1/customer/action/get_configuration`
Who can call it	Anyone. No token needed.

Query parameters

organization_idstringrequired
group_idinteger

Response

200 · application/json

OK.

buttonsarray of objectrequired
prechat_formobjectrequired
integrationsobjectrequired
propertiesobjectrequired
Under the key mlivechat: name, group_id, online, widget, prechat_enabled, postchat, agent.

Errors

default