Reference

API reference

Every endpoint of the public API and every webhook event, generated from the same schemas the API checks requests against.

Base URL https://business.linemeup.in/api/v1. Every request sends a key as Authorization: Bearer … — see Authentication. This page describes version 0.0.0 of the document.

Sample builder#

Choose an endpoint and fill in what you have. The request is written here and never sent — run it from your own system, with your key in LINEMEUP_API_KEY.

Business#

The fields and recipes are on the Business page.

GET `/business` #

The business this key belongs to — its name, category, time zone and today.

Needs the read scope · v1.business

Response (200)
Field	Type	Notes
`id`required	`string`
`name`required	`string`
`slug`required	`string`
`category`required	`enum`	One of "healthcare", "beauty_personal_care", "automotive", "food_beverage", "other"
`timeZone`required	`string`
`today`required	`string`
`clockFormat`required	`enum`	One of "12h", "24h"

Example request

curl

curl "https://business.linemeup.in/api/v1/business" \
  -H "Authorization: Bearer $LINEMEUP_API_KEY"

Node

const res = await fetch("https://business.linemeup.in/api/v1/business", {
  headers: {
    Authorization: `Bearer ${process.env.LINEMEUP_API_KEY}`,
  },
});
if (!res.ok) throw new Error(`Line Me Up answered ${res.status}`);
const answer = await res.json();

Python

import os
import requests

res = requests.get(
    "https://business.linemeup.in/api/v1/business",
    headers={
        "Authorization": f"Bearer {os.environ['LINEMEUP_API_KEY']}",
    },
    timeout=10,
)
res.raise_for_status()
answer = res.json()

PHP

<?php
$ch = curl_init("https://business.linemeup.in/api/v1/business");
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("LINEMEUP_API_KEY"),
    ],
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
]);
$answer = json_decode(curl_exec($ch), true);

Example response

{
  "id": "bus-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "name": "Sunrise Clinic",
  "slug": "sunrise-clinic",
  "category": "healthcare",
  "timeZone": "Asia/Kolkata",
  "today": "2026-10-30",
  "clockFormat": "12h"
}

Errors this can answer

401 Not authenticated
403 The key lacks the permission for this route, or the plan does not include integrations
404 Not found — or outside this key's business, lines or desks
409 The visit, line or desk is not in a state that allows this
422 Validation failed
429 Rate limited — wait for the Retry-After header's seconds

Every error has the same body — see Errors.

Lines#

The fields and recipes are on the Lines page.

GET `/lines` #

Every line this key may see, with how many are waiting on each.

Needs the read scope · v1.lines

Response (200)
Field	Type	Notes
`data`required	`array of object`
`data[].id`required	`string`
`data[].name`required	`string`
`data[].code`required	`string`
`data[].type`required	`enum`	One of "walk_in", "appointment", "scheduled_walk_in"
`data[].paused`required	`boolean`
`data[].waiting`required	`integer`
`data[].avgServiceMinutes`required	`integer`
`data[].maxCapacity`required	`integer`
`data[].description`required	`string \| null`
`data[].location`required	`string \| null`
`data[].callGraceMinutes`required	`integer`
`data[].appointmentGraceBeforeMinutes`required	`integer`
`data[].maxLateArrivalMinutes`required	`integer`
`data[].autoNoShowEnabled`required	`boolean`

Example request

curl

curl "https://business.linemeup.in/api/v1/lines" \
  -H "Authorization: Bearer $LINEMEUP_API_KEY"

Node

const res = await fetch("https://business.linemeup.in/api/v1/lines", {
  headers: {
    Authorization: `Bearer ${process.env.LINEMEUP_API_KEY}`,
  },
});
if (!res.ok) throw new Error(`Line Me Up answered ${res.status}`);
const answer = await res.json();

Python

import os
import requests

res = requests.get(
    "https://business.linemeup.in/api/v1/lines",
    headers={
        "Authorization": f"Bearer {os.environ['LINEMEUP_API_KEY']}",
    },
    timeout=10,
)
res.raise_for_status()
answer = res.json()

PHP

<?php
$ch = curl_init("https://business.linemeup.in/api/v1/lines");
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("LINEMEUP_API_KEY"),
    ],
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
]);
$answer = json_decode(curl_exec($ch), true);

Example response

{
  "data": [
    {
      "id": "line-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "name": "General",
      "code": "GEN",
      "type": "walk_in",
      "paused": false,
      "waiting": 4,
      "avgServiceMinutes": 10,
      "maxCapacity": 60,
      "description": "Walk-ins for a first visit",
      "location": "Ground floor",
      "callGraceMinutes": 5,
      "appointmentGraceBeforeMinutes": 10,
      "maxLateArrivalMinutes": 15,
      "autoNoShowEnabled": true
    },
    {
      "id": "line-0193f2a1-7c4e-7a10-9b2e-000000000002",
      "name": "X-ray",
      "code": "XR",
      "type": "scheduled_walk_in",
      "paused": false,
      "waiting": 1,
      "avgServiceMinutes": 15,
      "maxCapacity": 30,
      "description": null,
      "location": "First floor, room 4",
      "callGraceMinutes": 5,
      "appointmentGraceBeforeMinutes": 10,
      "maxLateArrivalMinutes": 10,
      "autoNoShowEnabled": true
    }
  ]
}

Errors this can answer

401 Not authenticated
403 The key lacks the permission for this route, or the plan does not include integrations
404 Not found — or outside this key's business, lines or desks
409 The visit, line or desk is not in a state that allows this
422 Validation failed
429 Rate limited — wait for the Retry-After header's seconds

Every error has the same body — see Errors.

PUT `/lines` #

Make a line, every setting said; refused to a key limited to some lines.

Needs the lines:manage scope · v1.lineCreate

Request body
Field	Type	Notes
`name`required	`string`	At least 1 characters. Up to 60 characters
`code`optional	`string`
`type`required	`enum`	One of "walk_in", "appointment", "scheduled_walk_in"
`avgServiceMinutes`required	`integer`	At least 1. At most 720
`maxCapacity`required	`integer`	At least 1. At most 9999
`description`optional	`string \| null`	Up to 280 characters
`location`optional	`string \| null`	Up to 120 characters
`callGraceMinutes`required	`integer`	At least 0. At most 120
`appointmentGraceBeforeMinutes`required	`integer`	At least 0. At most 240
`maxLateArrivalMinutes`required	`integer`	At least 0. At most 240
`autoNoShowEnabled`required	`boolean`

Response (200)
Field	Type	Notes
`id`required	`string`
`name`required	`string`
`code`required	`string`
`type`required	`enum`	One of "walk_in", "appointment", "scheduled_walk_in"
`paused`required	`boolean`
`waiting`required	`integer`
`avgServiceMinutes`required	`integer`
`maxCapacity`required	`integer`
`description`required	`string \| null`
`location`required	`string \| null`
`callGraceMinutes`required	`integer`
`appointmentGraceBeforeMinutes`required	`integer`
`maxLateArrivalMinutes`required	`integer`
`autoNoShowEnabled`required	`boolean`

Example request

curl

curl -X PUT "https://business.linemeup.in/api/v1/lines" \
  -H "Authorization: Bearer $LINEMEUP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Vaccinations","code":"VAC","type":"walk_in","avgServiceMinutes":5,"maxCapacity":80,"description":"Walk in for a scheduled vaccine","location":"Ground floor, room 2","callGraceMinutes":5,"appointmentGraceBeforeMinutes":0,"maxLateArrivalMinutes":0,"autoNoShowEnabled":true}'

Node

const res = await fetch("https://business.linemeup.in/api/v1/lines", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.LINEMEUP_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Vaccinations",
    "code": "VAC",
    "type": "walk_in",
    "avgServiceMinutes": 5,
    "maxCapacity": 80,
    "description": "Walk in for a scheduled vaccine",
    "location": "Ground floor, room 2",
    "callGraceMinutes": 5,
    "appointmentGraceBeforeMinutes": 0,
    "maxLateArrivalMinutes": 0,
    "autoNoShowEnabled": true
  }),
});
if (!res.ok) throw new Error(`Line Me Up answered ${res.status}`);
const answer = await res.json();

Python

import os
import requests

res = requests.put(
    "https://business.linemeup.in/api/v1/lines",
    headers={
        "Authorization": f"Bearer {os.environ['LINEMEUP_API_KEY']}",
    },
    json={
        "name": "Vaccinations",
        "code": "VAC",
        "type": "walk_in",
        "avgServiceMinutes": 5,
        "maxCapacity": 80,
        "description": "Walk in for a scheduled vaccine",
        "location": "Ground floor, room 2",
        "callGraceMinutes": 5,
        "appointmentGraceBeforeMinutes": 0,
        "maxLateArrivalMinutes": 0,
        "autoNoShowEnabled": True,
    },
    timeout=10,
)
res.raise_for_status()
answer = res.json()

PHP

<?php
$ch = curl_init("https://business.linemeup.in/api/v1/lines");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("LINEMEUP_API_KEY"),
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        "name" => 'Vaccinations',
        "code" => 'VAC',
        "type" => 'walk_in',
        "avgServiceMinutes" => 5,
        "maxCapacity" => 80,
        "description" => 'Walk in for a scheduled vaccine',
        "location" => 'Ground floor, room 2',
        "callGraceMinutes" => 5,
        "appointmentGraceBeforeMinutes" => 0,
        "maxLateArrivalMinutes" => 0,
        "autoNoShowEnabled" => true,
    ]),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
]);
$answer = json_decode(curl_exec($ch), true);

Example response

{
  "id": "line-0193f2a1-7c4e-7a10-9b2e-000000000003",
  "name": "Vaccinations",
  "code": "VAC",
  "type": "walk_in",
  "avgServiceMinutes": 5,
  "maxCapacity": 80,
  "description": "Walk in for a scheduled vaccine",
  "location": "Ground floor, room 2",
  "callGraceMinutes": 5,
  "appointmentGraceBeforeMinutes": 0,
  "maxLateArrivalMinutes": 0,
  "autoNoShowEnabled": true,
  "paused": false,
  "waiting": 0
}

Errors this can answer

401 Not authenticated
403 The key lacks the permission for this route, or the plan does not include integrations
404 Not found — or outside this key's business, lines or desks
409 The visit, line or desk is not in a state that allows this
422 Validation failed
429 Rate limited — wait for the Retry-After header's seconds

Every error has the same body — see Errors.

GET `/lines/{lineId}` #

One line and its settings; 404 for a line this key may not see.

Needs the read scope · v1.line

Parameters
Name	In	Type	Notes
`lineId`required	path	`string`

Response (200)
Field	Type	Notes
`id`required	`string`
`name`required	`string`
`code`required	`string`
`type`required	`enum`	One of "walk_in", "appointment", "scheduled_walk_in"
`paused`required	`boolean`
`waiting`required	`integer`
`avgServiceMinutes`required	`integer`
`maxCapacity`required	`integer`
`description`required	`string \| null`
`location`required	`string \| null`
`callGraceMinutes`required	`integer`
`appointmentGraceBeforeMinutes`required	`integer`
`maxLateArrivalMinutes`required	`integer`
`autoNoShowEnabled`required	`boolean`

Example request

curl

curl "https://business.linemeup.in/api/v1/lines/line-0193f2a1-7c4e-7a10-9b2e-000000000001" \
  -H "Authorization: Bearer $LINEMEUP_API_KEY"

Node

const res = await fetch("https://business.linemeup.in/api/v1/lines/line-0193f2a1-7c4e-7a10-9b2e-000000000001", {
  headers: {
    Authorization: `Bearer ${process.env.LINEMEUP_API_KEY}`,
  },
});
if (!res.ok) throw new Error(`Line Me Up answered ${res.status}`);
const answer = await res.json();

Python

import os
import requests

res = requests.get(
    "https://business.linemeup.in/api/v1/lines/line-0193f2a1-7c4e-7a10-9b2e-000000000001",
    headers={
        "Authorization": f"Bearer {os.environ['LINEMEUP_API_KEY']}",
    },
    timeout=10,
)
res.raise_for_status()
answer = res.json()

PHP

<?php
$ch = curl_init("https://business.linemeup.in/api/v1/lines/line-0193f2a1-7c4e-7a10-9b2e-000000000001");
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("LINEMEUP_API_KEY"),
    ],
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
]);
$answer = json_decode(curl_exec($ch), true);

Example response

{
  "id": "line-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "name": "General",
  "code": "GEN",
  "type": "walk_in",
  "paused": false,
  "waiting": 4,
  "avgServiceMinutes": 10,
  "maxCapacity": 60,
  "description": "Walk-ins for a first visit",
  "location": "Ground floor",
  "callGraceMinutes": 5,
  "appointmentGraceBeforeMinutes": 10,
  "maxLateArrivalMinutes": 15,
  "autoNoShowEnabled": true
}

Errors this can answer

401 Not authenticated
403 The key lacks the permission for this route, or the plan does not include integrations
404 Not found — or outside this key's business, lines or desks
409 The visit, line or desk is not in a state that allows this
422 Validation failed
429 Rate limited — wait for the Retry-After header's seconds

Every error has the same body — see Errors.

PUT `/lines/{lineId}` #

Replace a line's settings, every one said.

Needs the lines:manage scope · v1.lineReplace

Parameters
Name	In	Type	Notes
`lineId`required	path	`string`

Request body
Field	Type	Notes
`name`required	`string`	At least 1 characters. Up to 60 characters
`code`optional	`string`
`type`required	`enum`	One of "walk_in", "appointment", "scheduled_walk_in"
`avgServiceMinutes`required	`integer`	At least 1. At most 720
`maxCapacity`required	`integer`	At least 1. At most 9999
`description`optional	`string \| null`	Up to 280 characters
`location`optional	`string \| null`	Up to 120 characters
`callGraceMinutes`required	`integer`	At least 0. At most 120
`appointmentGraceBeforeMinutes`required	`integer`	At least 0. At most 240
`maxLateArrivalMinutes`required	`integer`	At least 0. At most 240
`autoNoShowEnabled`required	`boolean`

Response (200)
Field	Type	Notes
`id`required	`string`
`name`required	`string`
`code`required	`string`
`type`required	`enum`	One of "walk_in", "appointment", "scheduled_walk_in"
`paused`required	`boolean`
`waiting`required	`integer`
`avgServiceMinutes`required	`integer`
`maxCapacity`required	`integer`
`description`required	`string \| null`
`location`required	`string \| null`
`callGraceMinutes`required	`integer`
`appointmentGraceBeforeMinutes`required	`integer`
`maxLateArrivalMinutes`required	`integer`
`autoNoShowEnabled`required	`boolean`

Example request

curl

curl -X PUT "https://business.linemeup.in/api/v1/lines/line-0193f2a1-7c4e-7a10-9b2e-000000000001" \
  -H "Authorization: Bearer $LINEMEUP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"General","code":"GEN","type":"walk_in","avgServiceMinutes":12,"maxCapacity":50,"description":"Walk-ins for a first visit","location":"Ground floor","callGraceMinutes":5,"appointmentGraceBeforeMinutes":10,"maxLateArrivalMinutes":15,"autoNoShowEnabled":true}'

Node

const res = await fetch("https://business.linemeup.in/api/v1/lines/line-0193f2a1-7c4e-7a10-9b2e-000000000001", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.LINEMEUP_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "General",
    "code": "GEN",
    "type": "walk_in",
    "avgServiceMinutes": 12,
    "maxCapacity": 50,
    "description": "Walk-ins for a first visit",
    "location": "Ground floor",
    "callGraceMinutes": 5,
    "appointmentGraceBeforeMinutes": 10,
    "maxLateArrivalMinutes": 15,
    "autoNoShowEnabled": true
  }),
});
if (!res.ok) throw new Error(`Line Me Up answered ${res.status}`);
const answer = await res.json();

Python

import os
import requests

res = requests.put(
    "https://business.linemeup.in/api/v1/lines/line-0193f2a1-7c4e-7a10-9b2e-000000000001",
    headers={
        "Authorization": f"Bearer {os.environ['LINEMEUP_API_KEY']}",
    },
    json={
        "name": "General",
        "code": "GEN",
        "type": "walk_in",
        "avgServiceMinutes": 12,
        "maxCapacity": 50,
        "description": "Walk-ins for a first visit",
        "location": "Ground floor",
        "callGraceMinutes": 5,
        "appointmentGraceBeforeMinutes": 10,
        "maxLateArrivalMinutes": 15,
        "autoNoShowEnabled": True,
    },
    timeout=10,
)
res.raise_for_status()
answer = res.json()

PHP

<?php
$ch = curl_init("https://business.linemeup.in/api/v1/lines/line-0193f2a1-7c4e-7a10-9b2e-000000000001");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("LINEMEUP_API_KEY"),
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        "name" => 'General',
        "code" => 'GEN',
        "type" => 'walk_in',
        "avgServiceMinutes" => 12,
        "maxCapacity" => 50,
        "description" => 'Walk-ins for a first visit',
        "location" => 'Ground floor',
        "callGraceMinutes" => 5,
        "appointmentGraceBeforeMinutes" => 10,
        "maxLateArrivalMinutes" => 15,
        "autoNoShowEnabled" => true,
    ]),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
]);
$answer = json_decode(curl_exec($ch), true);

Example response

{
  "id": "line-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "name": "General",
  "code": "GEN",
  "type": "walk_in",
  "paused": false,
  "waiting": 4,
  "avgServiceMinutes": 12,
  "maxCapacity": 50,
  "description": "Walk-ins for a first visit",
  "location": "Ground floor",
  "callGraceMinutes": 5,
  "appointmentGraceBeforeMinutes": 10,
  "maxLateArrivalMinutes": 15,
  "autoNoShowEnabled": true
}

Errors this can answer

401 Not authenticated
403 The key lacks the permission for this route, or the plan does not include integrations
404 Not found — or outside this key's business, lines or desks
409 The visit, line or desk is not in a state that allows this
422 Validation failed
429 Rate limited — wait for the Retry-After header's seconds

Every error has the same body — see Errors.

POST `/lines/{lineId}/pause` #

Pause a line: nobody new joins it until it is resumed.

Needs the lines:manage scope · v1.linePause

Parameters
Name	In	Type	Notes
`lineId`required	path	`string`

Response (200)
Field	Type	Notes
`id`required	`string`
`name`required	`string`
`code`required	`string`
`type`required	`enum`	One of "walk_in", "appointment", "scheduled_walk_in"
`paused`required	`boolean`
`waiting`required	`integer`
`avgServiceMinutes`required	`integer`
`maxCapacity`required	`integer`
`description`required	`string \| null`
`location`required	`string \| null`
`callGraceMinutes`required	`integer`
`appointmentGraceBeforeMinutes`required	`integer`
`maxLateArrivalMinutes`required	`integer`
`autoNoShowEnabled`required	`boolean`

Example request

curl

curl -X POST "https://business.linemeup.in/api/v1/lines/line-0193f2a1-7c4e-7a10-9b2e-000000000001/pause" \
  -H "Authorization: Bearer $LINEMEUP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Node

const res = await fetch("https://business.linemeup.in/api/v1/lines/line-0193f2a1-7c4e-7a10-9b2e-000000000001/pause", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.LINEMEUP_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
if (!res.ok) throw new Error(`Line Me Up answered ${res.status}`);
const answer = await res.json();

Python

import os
import requests

res = requests.post(
    "https://business.linemeup.in/api/v1/lines/line-0193f2a1-7c4e-7a10-9b2e-000000000001/pause",
    headers={
        "Authorization": f"Bearer {os.environ['LINEMEUP_API_KEY']}",
    },
    json={},
    timeout=10,
)
res.raise_for_status()
answer = res.json()

PHP

<?php
$ch = curl_init("https://business.linemeup.in/api/v1/lines/line-0193f2a1-7c4e-7a10-9b2e-000000000001/pause");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("LINEMEUP_API_KEY"),
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode(new stdClass()),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
]);
$answer = json_decode(curl_exec($ch), true);

Example response

{
  "id": "line-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "name": "General",
  "code": "GEN",
  "type": "walk_in",
  "paused": true,
  "waiting": 4,
  "avgServiceMinutes": 10,
  "maxCapacity": 60,
  "description": "Walk-ins for a first visit",
  "location": "Ground floor",
  "callGraceMinutes": 5,
  "appointmentGraceBeforeMinutes": 10,
  "maxLateArrivalMinutes": 15,
  "autoNoShowEnabled": true
}

Errors this can answer

401 Not authenticated
403 The key lacks the permission for this route, or the plan does not include integrations
404 Not found — or outside this key's business, lines or desks
409 The visit, line or desk is not in a state that allows this
422 Validation failed
429 Rate limited — wait for the Retry-After header's seconds

Every error has the same body — see Errors.

POST `/lines/{lineId}/resume` #

Resume a paused line.

Needs the lines:manage scope · v1.lineResume

Parameters
Name	In	Type	Notes
`lineId`required	path	`string`

Response (200)
Field	Type	Notes
`id`required	`string`
`name`required	`string`
`code`required	`string`
`type`required	`enum`	One of "walk_in", "appointment", "scheduled_walk_in"
`paused`required	`boolean`
`waiting`required	`integer`
`avgServiceMinutes`required	`integer`
`maxCapacity`required	`integer`
`description`required	`string \| null`
`location`required	`string \| null`
`callGraceMinutes`required	`integer`
`appointmentGraceBeforeMinutes`required	`integer`
`maxLateArrivalMinutes`required	`integer`
`autoNoShowEnabled`required	`boolean`

Example request

curl

curl -X POST "https://business.linemeup.in/api/v1/lines/line-0193f2a1-7c4e-7a10-9b2e-000000000001/resume" \
  -H "Authorization: Bearer $LINEMEUP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Node

const res = await fetch("https://business.linemeup.in/api/v1/lines/line-0193f2a1-7c4e-7a10-9b2e-000000000001/resume", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.LINEMEUP_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
if (!res.ok) throw new Error(`Line Me Up answered ${res.status}`);
const answer = await res.json();

Python

import os
import requests

res = requests.post(
    "https://business.linemeup.in/api/v1/lines/line-0193f2a1-7c4e-7a10-9b2e-000000000001/resume",
    headers={
        "Authorization": f"Bearer {os.environ['LINEMEUP_API_KEY']}",
    },
    json={},
    timeout=10,
)
res.raise_for_status()
answer = res.json()

PHP

<?php
$ch = curl_init("https://business.linemeup.in/api/v1/lines/line-0193f2a1-7c4e-7a10-9b2e-000000000001/resume");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("LINEMEUP_API_KEY"),
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode(new stdClass()),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
]);
$answer = json_decode(curl_exec($ch), true);

Example response

{
  "id": "line-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "name": "General",
  "code": "GEN",
  "type": "walk_in",
  "paused": false,
  "waiting": 4,
  "avgServiceMinutes": 10,
  "maxCapacity": 60,
  "description": "Walk-ins for a first visit",
  "location": "Ground floor",
  "callGraceMinutes": 5,
  "appointmentGraceBeforeMinutes": 10,
  "maxLateArrivalMinutes": 15,
  "autoNoShowEnabled": true
}

Errors this can answer

401 Not authenticated
403 The key lacks the permission for this route, or the plan does not include integrations
404 Not found — or outside this key's business, lines or desks
409 The visit, line or desk is not in a state that allows this
422 Validation failed
429 Rate limited — wait for the Retry-After header's seconds

Every error has the same body — see Errors.

Services#

The fields and recipes are on the Services page.

GET `/services` #

The menu — every service on the lines this key may see.

Needs the read scope · v1.services

Response (200)
Field	Type	Notes
`data`required	`array of object`
`data[].id`required	`string`
`data[].name`required	`string`
`data[].parentId`required	`string \| null`
`data[].lineId`required	`string`
`data[].selectable`required	`boolean`
`data[].active`required	`boolean`
`data[].durationMinutes`required	`integer \| null`
`data[].pricePaise`required	`integer \| null`

Example request

curl

curl "https://business.linemeup.in/api/v1/services" \
  -H "Authorization: Bearer $LINEMEUP_API_KEY"

Node

const res = await fetch("https://business.linemeup.in/api/v1/services", {
  headers: {
    Authorization: `Bearer ${process.env.LINEMEUP_API_KEY}`,
  },
});
if (!res.ok) throw new Error(`Line Me Up answered ${res.status}`);
const answer = await res.json();

Python

import os
import requests

res = requests.get(
    "https://business.linemeup.in/api/v1/services",
    headers={
        "Authorization": f"Bearer {os.environ['LINEMEUP_API_KEY']}",
    },
    timeout=10,
)
res.raise_for_status()
answer = res.json()

PHP

<?php
$ch = curl_init("https://business.linemeup.in/api/v1/services");
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("LINEMEUP_API_KEY"),
    ],
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
]);
$answer = json_decode(curl_exec($ch), true);

Example response

{
  "data": [
    {
      "id": "svc-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "name": "Consultations",
      "parentId": null,
      "lineId": "line-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "selectable": false,
      "active": true,
      "durationMinutes": null,
      "pricePaise": null
    },
    {
      "id": "svc-0193f2a1-7c4e-7a10-9b2e-000000000002",
      "name": "General consultation",
      "parentId": "svc-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "lineId": "line-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "selectable": true,
      "active": true,
      "durationMinutes": 15,
      "pricePaise": 50000
    },
    {
      "id": "svc-0193f2a1-7c4e-7a10-9b2e-000000000003",
      "name": "Chest X-ray",
      "parentId": null,
      "lineId": "line-0193f2a1-7c4e-7a10-9b2e-000000000002",
      "selectable": true,
      "active": true,
      "durationMinutes": 20,
      "pricePaise": 120000
    }
  ]
}

Errors this can answer

401 Not authenticated
403 The key lacks the permission for this route, or the plan does not include integrations
404 Not found — or outside this key's business, lines or desks
409 The visit, line or desk is not in a state that allows this
422 Validation failed
429 Rate limited — wait for the Retry-After header's seconds

Every error has the same body — see Errors.

Desks#

The fields and recipes are on the Desks page.

GET `/desks` #

Every desk this key may see, and what state each is in.

Needs the read scope · v1.desks

Response (200)
Field	Type	Notes
`data`required	`array of object`
`data[].id`required	`string`
`data[].name`required	`string`
`data[].type`required	`enum`	One of "person", "counter"
`data[].publicLabel`required	`string \| null`
`data[].active`required	`boolean`
`data[].state`required	`enum`	One of "offline", "available", "called", "busy", "break"
`data[].lineIds`required	`array of string`

Example request

curl

curl "https://business.linemeup.in/api/v1/desks" \
  -H "Authorization: Bearer $LINEMEUP_API_KEY"

Node

const res = await fetch("https://business.linemeup.in/api/v1/desks", {
  headers: {
    Authorization: `Bearer ${process.env.LINEMEUP_API_KEY}`,
  },
});
if (!res.ok) throw new Error(`Line Me Up answered ${res.status}`);
const answer = await res.json();

Python

import os
import requests

res = requests.get(
    "https://business.linemeup.in/api/v1/desks",
    headers={
        "Authorization": f"Bearer {os.environ['LINEMEUP_API_KEY']}",
    },
    timeout=10,
)
res.raise_for_status()
answer = res.json()

PHP

<?php
$ch = curl_init("https://business.linemeup.in/api/v1/desks");
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("LINEMEUP_API_KEY"),
    ],
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
]);
$answer = json_decode(curl_exec($ch), true);

Example response

{
  "data": [
    {
      "id": "sta-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "name": "Dr Mehta",
      "type": "person",
      "publicLabel": "Room 1",
      "active": true,
      "state": "available",
      "lineIds": [
        "line-0193f2a1-7c4e-7a10-9b2e-000000000001"
      ]
    },
    {
      "id": "sta-0193f2a1-7c4e-7a10-9b2e-000000000002",
      "name": "X-ray counter",
      "type": "counter",
      "publicLabel": "Counter 2",
      "active": true,
      "state": "busy",
      "lineIds": [
        "line-0193f2a1-7c4e-7a10-9b2e-000000000002"
      ]
    }
  ]
}

Errors this can answer

401 Not authenticated
403 The key lacks the permission for this route, or the plan does not include integrations
404 Not found — or outside this key's business, lines or desks
409 The visit, line or desk is not in a state that allows this
422 Validation failed
429 Rate limited — wait for the Retry-After header's seconds

Every error has the same body — see Errors.

POST `/desks/{deskId}/call-next` #

Call the next visit to a desk, as its own Call next would.

Needs the desks:operate scope · v1.deskCallNext

Parameters
Name	In	Type	Notes
`deskId`required	path	`string`

Response (200)
Field	Type	Notes
`visit`required	`object \| null`
`visit.id`required	`string`
`visit.journeyId`required	`string`
`visit.token`required	`string`
`visit.lineId`required	`string`
`visit.status`required	`enum`	One of "booked", "queued", "called", "in_progress", "completed", "cancelled", "no_show"
`visit.bookingType`required	`enum`	One of "walk_in", "appointment", "scheduled_walk_in"
`visit.priority`required	`boolean`
`visit.note`required	`string \| null`
`visit.customer`required	`object`
`visit.customer.name`required	`string \| null`
`visit.customer.phone`required	`string \| null`
`visit.services`required	`array of object`
`visit.services[].id`required	`string`
`visit.services[].name`required	`string`
`visit.deskId`required	`string \| null`
`visit.position`required	`integer \| null`
`visit.slotAt`required	`string (date-time) \| null`
`visit.createdAt`required	`string (date-time)`
`visit.calledAt`required	`string (date-time) \| null`
`visit.startedAt`required	`string (date-time) \| null`
`visit.endedAt`required	`string (date-time) \| null`
`visit.updatedAt`required	`string (date-time)`
`waiting`required	`integer`
`held`required	`integer`

Example request

curl

curl -X POST "https://business.linemeup.in/api/v1/desks/sta-0193f2a1-7c4e-7a10-9b2e-000000000001/call-next" \
  -H "Authorization: Bearer $LINEMEUP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Node

const res = await fetch("https://business.linemeup.in/api/v1/desks/sta-0193f2a1-7c4e-7a10-9b2e-000000000001/call-next", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.LINEMEUP_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
if (!res.ok) throw new Error(`Line Me Up answered ${res.status}`);
const answer = await res.json();

Python

import os
import requests

res = requests.post(
    "https://business.linemeup.in/api/v1/desks/sta-0193f2a1-7c4e-7a10-9b2e-000000000001/call-next",
    headers={
        "Authorization": f"Bearer {os.environ['LINEMEUP_API_KEY']}",
    },
    json={},
    timeout=10,
)
res.raise_for_status()
answer = res.json()

PHP

<?php
$ch = curl_init("https://business.linemeup.in/api/v1/desks/sta-0193f2a1-7c4e-7a10-9b2e-000000000001/call-next");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("LINEMEUP_API_KEY"),
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode(new stdClass()),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
]);
$answer = json_decode(curl_exec($ch), true);

Example response

{
  "visit": {
    "id": "job-0193f2a1-7c4e-7a10-9b2e-000000000001",
    "journeyId": "jny-0193f2a1-7c4e-7a10-9b2e-000000000001",
    "token": "GEN-20261030-014",
    "lineId": "line-0193f2a1-7c4e-7a10-9b2e-000000000001",
    "status": "called",
    "bookingType": "walk_in",
    "priority": false,
    "note": "First visit",
    "customer": {
      "name": "Asha Rao",
      "phone": "+919000000001"
    },
    "services": [
      {
        "id": "svc-0193f2a1-7c4e-7a10-9b2e-000000000002",
        "name": "General consultation"
      }
    ],
    "deskId": "sta-0193f2a1-7c4e-7a10-9b2e-000000000001",
    "position": null,
    "slotAt": null,
    "createdAt": "2026-10-30T04:12:00.000Z",
    "calledAt": "2026-10-30T04:31:00.000Z",
    "startedAt": null,
    "endedAt": null,
    "updatedAt": "2026-10-30T04:31:00.000Z"
  },
  "waiting": 3,
  "held": 0
}

Errors this can answer

401 Not authenticated
403 The key lacks the permission for this route, or the plan does not include integrations
404 Not found — or outside this key's business, lines or desks
409 The visit, line or desk is not in a state that allows this
422 Validation failed
429 Rate limited — wait for the Retry-After header's seconds

Every error has the same body — see Errors.

PUT `/desks/{deskId}/status` #

Start a desk's shift, put it on a break, or end it.

Needs the desks:operate scope · v1.deskStatus

Parameters
Name	In	Type	Notes
`deskId`required	path	`string`

Request body
Field	Type	Notes
`state`required	`enum`	One of "available", "break", "offline"
`reason`optional	`enum`	One of "theatre", "rounds", "emergency_call", "break", "meal", "away", "other"
`backAt`optional	`string (date-time)`

Response (200)
Field	Type	Notes
`id`required	`string`
`name`required	`string`
`type`required	`enum`	One of "person", "counter"
`publicLabel`required	`string \| null`
`active`required	`boolean`
`state`required	`enum`	One of "offline", "available", "called", "busy", "break"
`lineIds`required	`array of string`

Example request

curl

curl -X PUT "https://business.linemeup.in/api/v1/desks/sta-0193f2a1-7c4e-7a10-9b2e-000000000001/status" \
  -H "Authorization: Bearer $LINEMEUP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"state":"available"}'

Node

const res = await fetch("https://business.linemeup.in/api/v1/desks/sta-0193f2a1-7c4e-7a10-9b2e-000000000001/status", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.LINEMEUP_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "state": "available"
  }),
});
if (!res.ok) throw new Error(`Line Me Up answered ${res.status}`);
const answer = await res.json();

Python

import os
import requests

res = requests.put(
    "https://business.linemeup.in/api/v1/desks/sta-0193f2a1-7c4e-7a10-9b2e-000000000001/status",
    headers={
        "Authorization": f"Bearer {os.environ['LINEMEUP_API_KEY']}",
    },
    json={
        "state": "available",
    },
    timeout=10,
)
res.raise_for_status()
answer = res.json()

PHP

<?php
$ch = curl_init("https://business.linemeup.in/api/v1/desks/sta-0193f2a1-7c4e-7a10-9b2e-000000000001/status");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("LINEMEUP_API_KEY"),
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        "state" => 'available',
    ]),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
]);
$answer = json_decode(curl_exec($ch), true);

Example response

{
  "id": "sta-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "name": "Dr Mehta",
  "type": "person",
  "publicLabel": "Room 1",
  "active": true,
  "state": "available",
  "lineIds": [
    "line-0193f2a1-7c4e-7a10-9b2e-000000000001"
  ]
}

Errors this can answer

401 Not authenticated
403 The key lacks the permission for this route, or the plan does not include integrations
404 Not found — or outside this key's business, lines or desks
409 The visit, line or desk is not in a state that allows this
422 Validation failed
429 Rate limited — wait for the Retry-After header's seconds

Every error has the same body — see Errors.

Visits#

The fields and recipes are on the Visits page.

GET `/visits` #

Visits, newest first, by cursor — filtered by status, line, day or change.

Needs the read scope · v1.visits

Parameters
Name	In	Type
`cursor`optional	query	`string`
`limit`optional	query	`integer`
`status`optional	query	`array of enum`
`lineId`optional	query	`array of string`
`from`optional	query	`string`
`to`optional	query	`string`
`updatedSince`optional	query	`string (date-time)`

Response (200)
Field	Type	Notes
`data`required	`array of object`
`data[].id`required	`string`
`data[].journeyId`required	`string`
`data[].token`required	`string`
`data[].lineId`required	`string`
`data[].status`required	`enum`	One of "booked", "queued", "called", "in_progress", "completed", "cancelled", "no_show"
`data[].bookingType`required	`enum`	One of "walk_in", "appointment", "scheduled_walk_in"
`data[].priority`required	`boolean`
`data[].note`required	`string \| null`
`data[].customer`required	`object`
`data[].customer.name`required	`string \| null`
`data[].customer.phone`required	`string \| null`
`data[].services`required	`array of object`
`data[].services[].id`required	`string`
`data[].services[].name`required	`string`
`data[].deskId`required	`string \| null`
`data[].position`required	`integer \| null`
`data[].slotAt`required	`string (date-time) \| null`
`data[].createdAt`required	`string (date-time)`
`data[].calledAt`required	`string (date-time) \| null`
`data[].startedAt`required	`string (date-time) \| null`
`data[].endedAt`required	`string (date-time) \| null`
`data[].updatedAt`required	`string (date-time)`
`nextCursor`required	`string \| null`

Example request

curl

curl "https://business.linemeup.in/api/v1/visits?lineId=line-0193f2a1-7c4e-7a10-9b2e-000000000001&from=2026-10-30&to=2026-10-30&limit=2" \
  -H "Authorization: Bearer $LINEMEUP_API_KEY"

Node

const res = await fetch("https://business.linemeup.in/api/v1/visits?lineId=line-0193f2a1-7c4e-7a10-9b2e-000000000001&from=2026-10-30&to=2026-10-30&limit=2", {
  headers: {
    Authorization: `Bearer ${process.env.LINEMEUP_API_KEY}`,
  },
});
if (!res.ok) throw new Error(`Line Me Up answered ${res.status}`);
const answer = await res.json();

Python

import os
import requests

res = requests.get(
    "https://business.linemeup.in/api/v1/visits?lineId=line-0193f2a1-7c4e-7a10-9b2e-000000000001&from=2026-10-30&to=2026-10-30&limit=2",
    headers={
        "Authorization": f"Bearer {os.environ['LINEMEUP_API_KEY']}",
    },
    timeout=10,
)
res.raise_for_status()
answer = res.json()

PHP

<?php
$ch = curl_init("https://business.linemeup.in/api/v1/visits?lineId=line-0193f2a1-7c4e-7a10-9b2e-000000000001&from=2026-10-30&to=2026-10-30&limit=2");
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("LINEMEUP_API_KEY"),
    ],
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
]);
$answer = json_decode(curl_exec($ch), true);

Example response

{
  "data": [
    {
      "id": "job-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "journeyId": "jny-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "token": "GEN-20261030-014",
      "lineId": "line-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "status": "queued",
      "bookingType": "walk_in",
      "priority": false,
      "note": "First visit",
      "customer": {
        "name": "Asha Rao",
        "phone": "+919000000001"
      },
      "services": [
        {
          "id": "svc-0193f2a1-7c4e-7a10-9b2e-000000000002",
          "name": "General consultation"
        }
      ],
      "deskId": null,
      "position": 3,
      "slotAt": null,
      "createdAt": "2026-10-30T04:12:00.000Z",
      "calledAt": null,
      "startedAt": null,
      "endedAt": null,
      "updatedAt": "2026-10-30T04:12:00.000Z"
    },
    {
      "id": "job-0193f2a1-7c4e-7a10-9b2e-000000000004",
      "journeyId": "jny-0193f2a1-7c4e-7a10-9b2e-000000000004",
      "token": "GEN-20261030-009",
      "lineId": "line-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "status": "completed",
      "bookingType": "walk_in",
      "priority": false,
      "note": null,
      "customer": {
        "name": null,
        "phone": null
      },
      "services": [
        {
          "id": "svc-0193f2a1-7c4e-7a10-9b2e-000000000002",
          "name": "General consultation"
        }
      ],
      "deskId": "sta-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "position": null,
      "slotAt": null,
      "createdAt": "2026-10-30T03:40:00.000Z",
      "calledAt": "2026-10-30T03:58:00.000Z",
      "startedAt": "2026-10-30T03:59:00.000Z",
      "endedAt": "2026-10-30T04:10:00.000Z",
      "updatedAt": "2026-10-30T04:10:00.000Z"
    }
  ],
  "nextCursor": "MjAyNi0xMC0yNVQwNDoxMDowMC4wMDAwMDBafGpvYi0wMDA0"
}

Errors this can answer

401 Not authenticated
403 The key lacks the permission for this route, or the plan does not include integrations
404 Not found — or outside this key's business, lines or desks
409 The visit, line or desk is not in a state that allows this
422 Validation failed
429 Rate limited — wait for the Retry-After header's seconds

Every error has the same body — see Errors.

POST `/visits` #

Add a walk-in on a line or for services; honours Idempotency-Key.

Needs the visits:write scope · v1.visitCreate

Parameters
Name	In	Type	Notes
`Idempotency-Key`optional	header	`string`	Any string up to 255 characters. The same key within 24 hours returns the first answer instead of adding a second visit.

Request body
Field	Type	Notes
`lineId`optional	`string`	At least 1 characters. Up to 64 characters
`serviceIds`optional	`array of string`	At least 1 items. Up to 20 items
`customer`optional	`object`
`customer.name`optional	`string \| null`	At least 1 characters. Up to 80 characters
`customer.phone`optional	`string \| null`	At least 3 characters. Up to 24 characters
`note`optional	`string \| null`	Up to 140 characters
`priority`optional	`boolean`
`reference`optional	`string \| null`	At least 1 characters. Up to 40 characters
`consent`optional	`boolean`

Response (200)
Field	Type	Notes
`data`required	`array of object`	At least 1 items
`data[].id`required	`string`
`data[].journeyId`required	`string`
`data[].token`required	`string`
`data[].lineId`required	`string`
`data[].status`required	`enum`	One of "booked", "queued", "called", "in_progress", "completed", "cancelled", "no_show"
`data[].bookingType`required	`enum`	One of "walk_in", "appointment", "scheduled_walk_in"
`data[].priority`required	`boolean`
`data[].note`required	`string \| null`
`data[].customer`required	`object`
`data[].customer.name`required	`string \| null`
`data[].customer.phone`required	`string \| null`
`data[].services`required	`array of object`
`data[].services[].id`required	`string`
`data[].services[].name`required	`string`
`data[].deskId`required	`string \| null`
`data[].position`required	`integer \| null`
`data[].slotAt`required	`string (date-time) \| null`
`data[].createdAt`required	`string (date-time)`
`data[].calledAt`required	`string (date-time) \| null`
`data[].startedAt`required	`string (date-time) \| null`
`data[].endedAt`required	`string (date-time) \| null`
`data[].updatedAt`required	`string (date-time)`

Example request

curl

curl -X POST "https://business.linemeup.in/api/v1/visits" \
  -H "Authorization: Bearer $LINEMEUP_API_KEY" \
  -H "Idempotency-Key: crm-visit-1042" \
  -H "Content-Type: application/json" \
  -d '{"lineId":"line-0193f2a1-7c4e-7a10-9b2e-000000000001","customer":{"name":"Asha Rao","phone":"+919000000001"},"note":"First visit","reference":"CRM-1042","consent":true}'

Node

const res = await fetch("https://business.linemeup.in/api/v1/visits", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.LINEMEUP_API_KEY}`,
    "Idempotency-Key": "crm-visit-1042",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "lineId": "line-0193f2a1-7c4e-7a10-9b2e-000000000001",
    "customer": {
      "name": "Asha Rao",
      "phone": "+919000000001"
    },
    "note": "First visit",
    "reference": "CRM-1042",
    "consent": true
  }),
});
if (!res.ok) throw new Error(`Line Me Up answered ${res.status}`);
const answer = await res.json();

Python

import os
import requests

res = requests.post(
    "https://business.linemeup.in/api/v1/visits",
    headers={
        "Authorization": f"Bearer {os.environ['LINEMEUP_API_KEY']}",
        "Idempotency-Key": "crm-visit-1042",
    },
    json={
        "lineId": "line-0193f2a1-7c4e-7a10-9b2e-000000000001",
        "customer": {
            "name": "Asha Rao",
            "phone": "+919000000001",
        },
        "note": "First visit",
        "reference": "CRM-1042",
        "consent": True,
    },
    timeout=10,
)
res.raise_for_status()
answer = res.json()

PHP

<?php
$ch = curl_init("https://business.linemeup.in/api/v1/visits");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("LINEMEUP_API_KEY"),
        "Idempotency-Key: crm-visit-1042",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        "lineId" => 'line-0193f2a1-7c4e-7a10-9b2e-000000000001',
        "customer" => [
            "name" => 'Asha Rao',
            "phone" => '+919000000001',
        ],
        "note" => 'First visit',
        "reference" => 'CRM-1042',
        "consent" => true,
    ]),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
]);
$answer = json_decode(curl_exec($ch), true);

Example response

{
  "data": [
    {
      "id": "job-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "journeyId": "jny-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "token": "GEN-20261030-014",
      "lineId": "line-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "status": "queued",
      "bookingType": "walk_in",
      "priority": false,
      "note": "First visit",
      "customer": {
        "name": "Asha Rao",
        "phone": "+919000000001"
      },
      "services": [
        {
          "id": "svc-0193f2a1-7c4e-7a10-9b2e-000000000002",
          "name": "General consultation"
        }
      ],
      "deskId": null,
      "position": 3,
      "slotAt": null,
      "createdAt": "2026-10-30T04:12:00.000Z",
      "calledAt": null,
      "startedAt": null,
      "endedAt": null,
      "updatedAt": "2026-10-30T04:12:00.000Z"
    }
  ]
}

Errors this can answer

401 Not authenticated
403 The key lacks the permission for this route, or the plan does not include integrations
404 Not found — or outside this key's business, lines or desks
409 The visit, line or desk is not in a state that allows this
422 Validation failed
429 Rate limited — wait for the Retry-After header's seconds

Every error has the same body — see Errors.

GET `/visits/{visitId}` #

One visit, with its customer, services, desk and times.

Needs the read scope · v1.visit

Parameters
Name	In	Type	Notes
`visitId`required	path	`string`

Response (200)
Field	Type	Notes
`id`required	`string`
`journeyId`required	`string`
`token`required	`string`
`lineId`required	`string`
`status`required	`enum`	One of "booked", "queued", "called", "in_progress", "completed", "cancelled", "no_show"
`bookingType`required	`enum`	One of "walk_in", "appointment", "scheduled_walk_in"
`priority`required	`boolean`
`note`required	`string \| null`
`customer`required	`object`
`customer.name`required	`string \| null`
`customer.phone`required	`string \| null`
`services`required	`array of object`
`services[].id`required	`string`
`services[].name`required	`string`
`deskId`required	`string \| null`
`position`required	`integer \| null`
`slotAt`required	`string (date-time) \| null`
`createdAt`required	`string (date-time)`
`calledAt`required	`string (date-time) \| null`
`startedAt`required	`string (date-time) \| null`
`endedAt`required	`string (date-time) \| null`
`updatedAt`required	`string (date-time)`

Example request

curl

curl "https://business.linemeup.in/api/v1/visits/job-0193f2a1-7c4e-7a10-9b2e-000000000001" \
  -H "Authorization: Bearer $LINEMEUP_API_KEY"

Node

const res = await fetch("https://business.linemeup.in/api/v1/visits/job-0193f2a1-7c4e-7a10-9b2e-000000000001", {
  headers: {
    Authorization: `Bearer ${process.env.LINEMEUP_API_KEY}`,
  },
});
if (!res.ok) throw new Error(`Line Me Up answered ${res.status}`);
const answer = await res.json();

Python

import os
import requests

res = requests.get(
    "https://business.linemeup.in/api/v1/visits/job-0193f2a1-7c4e-7a10-9b2e-000000000001",
    headers={
        "Authorization": f"Bearer {os.environ['LINEMEUP_API_KEY']}",
    },
    timeout=10,
)
res.raise_for_status()
answer = res.json()

PHP

<?php
$ch = curl_init("https://business.linemeup.in/api/v1/visits/job-0193f2a1-7c4e-7a10-9b2e-000000000001");
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("LINEMEUP_API_KEY"),
    ],
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
]);
$answer = json_decode(curl_exec($ch), true);

Example response

{
  "id": "job-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "journeyId": "jny-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "token": "GEN-20261030-014",
  "lineId": "line-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "status": "queued",
  "bookingType": "walk_in",
  "priority": false,
  "note": "First visit",
  "customer": {
    "name": "Asha Rao",
    "phone": "+919000000001"
  },
  "services": [
    {
      "id": "svc-0193f2a1-7c4e-7a10-9b2e-000000000002",
      "name": "General consultation"
    }
  ],
  "deskId": null,
  "position": 3,
  "slotAt": null,
  "createdAt": "2026-10-30T04:12:00.000Z",
  "calledAt": null,
  "startedAt": null,
  "endedAt": null,
  "updatedAt": "2026-10-30T04:12:00.000Z"
}

Errors this can answer

401 Not authenticated
403 The key lacks the permission for this route, or the plan does not include integrations
404 Not found — or outside this key's business, lines or desks
409 The visit, line or desk is not in a state that allows this
422 Validation failed
429 Rate limited — wait for the Retry-After header's seconds

Every error has the same body — see Errors.

PATCH `/visits/{visitId}` #

Change a visit's urgency or its note.

Needs the visits:write scope · v1.visitUpdate

Parameters
Name	In	Type	Notes
`visitId`required	path	`string`

Request body
Field	Type	Notes
`priority`optional	`boolean`
`note`optional	`string \| null`	Up to 140 characters

Response (200)
Field	Type	Notes
`id`required	`string`
`journeyId`required	`string`
`token`required	`string`
`lineId`required	`string`
`status`required	`enum`	One of "booked", "queued", "called", "in_progress", "completed", "cancelled", "no_show"
`bookingType`required	`enum`	One of "walk_in", "appointment", "scheduled_walk_in"
`priority`required	`boolean`
`note`required	`string \| null`
`customer`required	`object`
`customer.name`required	`string \| null`
`customer.phone`required	`string \| null`
`services`required	`array of object`
`services[].id`required	`string`
`services[].name`required	`string`
`deskId`required	`string \| null`
`position`required	`integer \| null`
`slotAt`required	`string (date-time) \| null`
`createdAt`required	`string (date-time)`
`calledAt`required	`string (date-time) \| null`
`startedAt`required	`string (date-time) \| null`
`endedAt`required	`string (date-time) \| null`
`updatedAt`required	`string (date-time)`

Example request

curl

curl -X PATCH "https://business.linemeup.in/api/v1/visits/job-0193f2a1-7c4e-7a10-9b2e-000000000001" \
  -H "Authorization: Bearer $LINEMEUP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"note":"Needs a wheelchair at the door"}'

Node

const res = await fetch("https://business.linemeup.in/api/v1/visits/job-0193f2a1-7c4e-7a10-9b2e-000000000001", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.LINEMEUP_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "note": "Needs a wheelchair at the door"
  }),
});
if (!res.ok) throw new Error(`Line Me Up answered ${res.status}`);
const answer = await res.json();

Python

import os
import requests

res = requests.patch(
    "https://business.linemeup.in/api/v1/visits/job-0193f2a1-7c4e-7a10-9b2e-000000000001",
    headers={
        "Authorization": f"Bearer {os.environ['LINEMEUP_API_KEY']}",
    },
    json={
        "note": "Needs a wheelchair at the door",
    },
    timeout=10,
)
res.raise_for_status()
answer = res.json()

PHP

<?php
$ch = curl_init("https://business.linemeup.in/api/v1/visits/job-0193f2a1-7c4e-7a10-9b2e-000000000001");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "PATCH",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("LINEMEUP_API_KEY"),
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        "note" => 'Needs a wheelchair at the door',
    ]),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
]);
$answer = json_decode(curl_exec($ch), true);

Example response

{
  "id": "job-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "journeyId": "jny-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "token": "GEN-20261030-014",
  "lineId": "line-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "status": "queued",
  "bookingType": "walk_in",
  "priority": false,
  "note": "Needs a wheelchair at the door",
  "customer": {
    "name": "Asha Rao",
    "phone": "+919000000001"
  },
  "services": [
    {
      "id": "svc-0193f2a1-7c4e-7a10-9b2e-000000000002",
      "name": "General consultation"
    }
  ],
  "deskId": null,
  "position": 3,
  "slotAt": null,
  "createdAt": "2026-10-30T04:12:00.000Z",
  "calledAt": null,
  "startedAt": null,
  "endedAt": null,
  "updatedAt": "2026-10-30T04:16:00.000Z"
}

Errors this can answer

401 Not authenticated
403 The key lacks the permission for this route, or the plan does not include integrations
404 Not found — or outside this key's business, lines or desks
409 The visit, line or desk is not in a state that allows this
422 Validation failed
429 Rate limited — wait for the Retry-After header's seconds

Every error has the same body — see Errors.

POST `/visits/{visitId}/transitions` #

Move a visit along one edge: call, serve, complete, no-show, cancel, put back.

Needs the desks:operate scope · v1.visitTransition

Parameters
Name	In	Type	Notes
`visitId`required	path	`string`

Request body
Field	Type	Notes
`to`required	`enum`	One of "queued", "called", "in_progress", "completed", "no_show", "cancelled"
`deskId`optional	`string`	At least 1 characters. Up to 64 characters

Response (200)
Field	Type	Notes
`id`required	`string`
`journeyId`required	`string`
`token`required	`string`
`lineId`required	`string`
`status`required	`enum`	One of "booked", "queued", "called", "in_progress", "completed", "cancelled", "no_show"
`bookingType`required	`enum`	One of "walk_in", "appointment", "scheduled_walk_in"
`priority`required	`boolean`
`note`required	`string \| null`
`customer`required	`object`
`customer.name`required	`string \| null`
`customer.phone`required	`string \| null`
`services`required	`array of object`
`services[].id`required	`string`
`services[].name`required	`string`
`deskId`required	`string \| null`
`position`required	`integer \| null`
`slotAt`required	`string (date-time) \| null`
`createdAt`required	`string (date-time)`
`calledAt`required	`string (date-time) \| null`
`startedAt`required	`string (date-time) \| null`
`endedAt`required	`string (date-time) \| null`
`updatedAt`required	`string (date-time)`

Example request

curl

curl -X POST "https://business.linemeup.in/api/v1/visits/job-0193f2a1-7c4e-7a10-9b2e-000000000001/transitions" \
  -H "Authorization: Bearer $LINEMEUP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":"called","deskId":"sta-0193f2a1-7c4e-7a10-9b2e-000000000001"}'

Node

const res = await fetch("https://business.linemeup.in/api/v1/visits/job-0193f2a1-7c4e-7a10-9b2e-000000000001/transitions", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.LINEMEUP_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "to": "called",
    "deskId": "sta-0193f2a1-7c4e-7a10-9b2e-000000000001"
  }),
});
if (!res.ok) throw new Error(`Line Me Up answered ${res.status}`);
const answer = await res.json();

Python

import os
import requests

res = requests.post(
    "https://business.linemeup.in/api/v1/visits/job-0193f2a1-7c4e-7a10-9b2e-000000000001/transitions",
    headers={
        "Authorization": f"Bearer {os.environ['LINEMEUP_API_KEY']}",
    },
    json={
        "to": "called",
        "deskId": "sta-0193f2a1-7c4e-7a10-9b2e-000000000001",
    },
    timeout=10,
)
res.raise_for_status()
answer = res.json()

PHP

<?php
$ch = curl_init("https://business.linemeup.in/api/v1/visits/job-0193f2a1-7c4e-7a10-9b2e-000000000001/transitions");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("LINEMEUP_API_KEY"),
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        "to" => 'called',
        "deskId" => 'sta-0193f2a1-7c4e-7a10-9b2e-000000000001',
    ]),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
]);
$answer = json_decode(curl_exec($ch), true);

Example response

{
  "id": "job-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "journeyId": "jny-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "token": "GEN-20261030-014",
  "lineId": "line-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "status": "called",
  "bookingType": "walk_in",
  "priority": false,
  "note": "First visit",
  "customer": {
    "name": "Asha Rao",
    "phone": "+919000000001"
  },
  "services": [
    {
      "id": "svc-0193f2a1-7c4e-7a10-9b2e-000000000002",
      "name": "General consultation"
    }
  ],
  "deskId": "sta-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "position": null,
  "slotAt": null,
  "createdAt": "2026-10-30T04:12:00.000Z",
  "calledAt": "2026-10-30T04:31:00.000Z",
  "startedAt": null,
  "endedAt": null,
  "updatedAt": "2026-10-30T04:31:00.000Z"
}

Errors this can answer

401 Not authenticated
403 The key lacks the permission for this route, or the plan does not include integrations
404 Not found — or outside this key's business, lines or desks
409 The visit, line or desk is not in a state that allows this
422 Validation failed
429 Rate limited — wait for the Retry-After header's seconds

Every error has the same body — see Errors.

POST `/visits/{visitId}/urgent` #

Mark a waiting visit urgent — above everyone, and the desk alerted.

Needs the visits:write scope · v1.visitUrgent

Parameters
Name	In	Type	Notes
`visitId`required	path	`string`

Response (200)
Field	Type	Notes
`id`required	`string`
`journeyId`required	`string`
`token`required	`string`
`lineId`required	`string`
`status`required	`enum`	One of "booked", "queued", "called", "in_progress", "completed", "cancelled", "no_show"
`bookingType`required	`enum`	One of "walk_in", "appointment", "scheduled_walk_in"
`priority`required	`boolean`
`note`required	`string \| null`
`customer`required	`object`
`customer.name`required	`string \| null`
`customer.phone`required	`string \| null`
`services`required	`array of object`
`services[].id`required	`string`
`services[].name`required	`string`
`deskId`required	`string \| null`
`position`required	`integer \| null`
`slotAt`required	`string (date-time) \| null`
`createdAt`required	`string (date-time)`
`calledAt`required	`string (date-time) \| null`
`startedAt`required	`string (date-time) \| null`
`endedAt`required	`string (date-time) \| null`
`updatedAt`required	`string (date-time)`

Example request

curl

curl -X POST "https://business.linemeup.in/api/v1/visits/job-0193f2a1-7c4e-7a10-9b2e-000000000001/urgent" \
  -H "Authorization: Bearer $LINEMEUP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Node

const res = await fetch("https://business.linemeup.in/api/v1/visits/job-0193f2a1-7c4e-7a10-9b2e-000000000001/urgent", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.LINEMEUP_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
if (!res.ok) throw new Error(`Line Me Up answered ${res.status}`);
const answer = await res.json();

Python

import os
import requests

res = requests.post(
    "https://business.linemeup.in/api/v1/visits/job-0193f2a1-7c4e-7a10-9b2e-000000000001/urgent",
    headers={
        "Authorization": f"Bearer {os.environ['LINEMEUP_API_KEY']}",
    },
    json={},
    timeout=10,
)
res.raise_for_status()
answer = res.json()

PHP

<?php
$ch = curl_init("https://business.linemeup.in/api/v1/visits/job-0193f2a1-7c4e-7a10-9b2e-000000000001/urgent");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("LINEMEUP_API_KEY"),
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode(new stdClass()),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
]);
$answer = json_decode(curl_exec($ch), true);

Example response

{
  "id": "job-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "journeyId": "jny-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "token": "GEN-20261030-014",
  "lineId": "line-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "status": "queued",
  "bookingType": "walk_in",
  "priority": true,
  "note": "First visit",
  "customer": {
    "name": "Asha Rao",
    "phone": "+919000000001"
  },
  "services": [
    {
      "id": "svc-0193f2a1-7c4e-7a10-9b2e-000000000002",
      "name": "General consultation"
    }
  ],
  "deskId": null,
  "position": 1,
  "slotAt": null,
  "createdAt": "2026-10-30T04:12:00.000Z",
  "calledAt": null,
  "startedAt": null,
  "endedAt": null,
  "updatedAt": "2026-10-30T04:15:00.000Z"
}

Errors this can answer

401 Not authenticated
403 The key lacks the permission for this route, or the plan does not include integrations
404 Not found — or outside this key's business, lines or desks
409 The visit, line or desk is not in a state that allows this
422 Validation failed
429 Rate limited — wait for the Retry-After header's seconds

Every error has the same body — see Errors.

Webhook events#

How to receive and verify them is on Webhooks.

EVENT `visit.created` #

Arrives as a POST to your endpoint with LineMeUp-Signature , LineMeUp-Event-Id , LineMeUp-Event-Type and LineMeUp-Delivery-Id .

Payload
Field	Type	Notes
`id`required	`string`
`type`required	`string`	Always "visit.created"
`apiVersion`required	`string`	Always "v1"
`createdAt`required	`string (date-time)`
`businessId`required	`string`
`test`required	`boolean`
`data`required	`object`
`data.visit`required	`object`
`data.visit.id`required	`string`
`data.visit.journeyId`required	`string`
`data.visit.token`required	`string`
`data.visit.lineId`required	`string`
`data.visit.status`required	`enum`	One of "booked", "queued", "called", "in_progress", "completed", "cancelled", "no_show"
`data.visit.bookingType`required	`enum`	One of "walk_in", "appointment", "scheduled_walk_in"
`data.visit.priority`required	`boolean`
`data.visit.customer`required	`object`
`data.visit.customer.name`required	`string \| null`
`data.visit.customer.phone`required	`string \| null`
`data.visit.services`required	`array of object`
`data.visit.services[].id`required	`string`
`data.visit.services[].name`required	`string`
`data.visit.deskId`required	`string \| null`
`data.visit.position`required	`integer \| null`
`data.visit.slotAt`required	`string (date-time) \| null`
`data.visit.createdAt`required	`string (date-time)`
`data.visit.calledAt`required	`string (date-time) \| null`
`data.visit.startedAt`required	`string (date-time) \| null`
`data.visit.endedAt`required	`string (date-time) \| null`
`data.visit.updatedAt`required	`string (date-time)`

Example payload

{
  "id": "evt-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "type": "visit.created",
  "apiVersion": "v1",
  "createdAt": "2026-10-30T04:12:00.000Z",
  "businessId": "bus-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "test": false,
  "data": {
    "visit": {
      "id": "job-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "journeyId": "jny-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "token": "GEN-20261030-014",
      "lineId": "line-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "status": "queued",
      "bookingType": "walk_in",
      "priority": false,
      "customer": {
        "name": "Asha Rao",
        "phone": "+919000000001"
      },
      "services": [
        {
          "id": "svc-0193f2a1-7c4e-7a10-9b2e-000000000002",
          "name": "General consultation"
        }
      ],
      "deskId": null,
      "position": 3,
      "slotAt": null,
      "createdAt": "2026-10-30T04:12:00.000Z",
      "calledAt": null,
      "startedAt": null,
      "endedAt": null,
      "updatedAt": "2026-10-30T04:12:00.000Z"
    }
  }
}

EVENT `visit.status_changed` #

Arrives as a POST to your endpoint with LineMeUp-Signature , LineMeUp-Event-Id , LineMeUp-Event-Type and LineMeUp-Delivery-Id .

Payload
Field	Type	Notes
`id`required	`string`
`type`required	`string`	Always "visit.status_changed"
`apiVersion`required	`string`	Always "v1"
`createdAt`required	`string (date-time)`
`businessId`required	`string`
`test`required	`boolean`
`data`required	`object`
`data.visit`required	`object`
`data.visit.id`required	`string`
`data.visit.journeyId`required	`string`
`data.visit.token`required	`string`
`data.visit.lineId`required	`string`
`data.visit.status`required	`enum`	One of "booked", "queued", "called", "in_progress", "completed", "cancelled", "no_show"
`data.visit.bookingType`required	`enum`	One of "walk_in", "appointment", "scheduled_walk_in"
`data.visit.priority`required	`boolean`
`data.visit.customer`required	`object`
`data.visit.customer.name`required	`string \| null`
`data.visit.customer.phone`required	`string \| null`
`data.visit.services`required	`array of object`
`data.visit.services[].id`required	`string`
`data.visit.services[].name`required	`string`
`data.visit.deskId`required	`string \| null`
`data.visit.position`required	`integer \| null`
`data.visit.slotAt`required	`string (date-time) \| null`
`data.visit.createdAt`required	`string (date-time)`
`data.visit.calledAt`required	`string (date-time) \| null`
`data.visit.startedAt`required	`string (date-time) \| null`
`data.visit.endedAt`required	`string (date-time) \| null`
`data.visit.updatedAt`required	`string (date-time)`
`data.from`required	`enum`	One of "booked", "queued", "called", "in_progress", "completed", "cancelled", "no_show"
`data.to`required	`enum`	One of "booked", "queued", "called", "in_progress", "completed", "cancelled", "no_show"

Example payload

{
  "id": "evt-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "type": "visit.status_changed",
  "apiVersion": "v1",
  "createdAt": "2026-10-30T04:31:00.000Z",
  "businessId": "bus-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "test": false,
  "data": {
    "visit": {
      "id": "job-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "journeyId": "jny-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "token": "GEN-20261030-014",
      "lineId": "line-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "status": "called",
      "bookingType": "walk_in",
      "priority": false,
      "customer": {
        "name": "Asha Rao",
        "phone": "+919000000001"
      },
      "services": [
        {
          "id": "svc-0193f2a1-7c4e-7a10-9b2e-000000000002",
          "name": "General consultation"
        }
      ],
      "deskId": "sta-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "position": null,
      "slotAt": null,
      "createdAt": "2026-10-30T04:12:00.000Z",
      "calledAt": "2026-10-30T04:31:00.000Z",
      "startedAt": null,
      "endedAt": null,
      "updatedAt": "2026-10-30T04:31:00.000Z"
    },
    "from": "queued",
    "to": "called"
  }
}

EVENT `visit.updated` #

Arrives as a POST to your endpoint with LineMeUp-Signature , LineMeUp-Event-Id , LineMeUp-Event-Type and LineMeUp-Delivery-Id .

Payload
Field	Type	Notes
`id`required	`string`
`type`required	`string`	Always "visit.updated"
`apiVersion`required	`string`	Always "v1"
`createdAt`required	`string (date-time)`
`businessId`required	`string`
`test`required	`boolean`
`data`required	`object`
`data.visit`required	`object`
`data.visit.id`required	`string`
`data.visit.journeyId`required	`string`
`data.visit.token`required	`string`
`data.visit.lineId`required	`string`
`data.visit.status`required	`enum`	One of "booked", "queued", "called", "in_progress", "completed", "cancelled", "no_show"
`data.visit.bookingType`required	`enum`	One of "walk_in", "appointment", "scheduled_walk_in"
`data.visit.priority`required	`boolean`
`data.visit.customer`required	`object`
`data.visit.customer.name`required	`string \| null`
`data.visit.customer.phone`required	`string \| null`
`data.visit.services`required	`array of object`
`data.visit.services[].id`required	`string`
`data.visit.services[].name`required	`string`
`data.visit.deskId`required	`string \| null`
`data.visit.position`required	`integer \| null`
`data.visit.slotAt`required	`string (date-time) \| null`
`data.visit.createdAt`required	`string (date-time)`
`data.visit.calledAt`required	`string (date-time) \| null`
`data.visit.startedAt`required	`string (date-time) \| null`
`data.visit.endedAt`required	`string (date-time) \| null`
`data.visit.updatedAt`required	`string (date-time)`
`data.changed`required	`array of enum`	At least 1 items

Example payload

{
  "id": "evt-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "type": "visit.updated",
  "apiVersion": "v1",
  "createdAt": "2026-10-30T04:15:00.000Z",
  "businessId": "bus-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "test": false,
  "data": {
    "visit": {
      "id": "job-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "journeyId": "jny-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "token": "GEN-20261030-014",
      "lineId": "line-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "status": "queued",
      "bookingType": "walk_in",
      "priority": true,
      "customer": {
        "name": "Asha Rao",
        "phone": "+919000000001"
      },
      "services": [
        {
          "id": "svc-0193f2a1-7c4e-7a10-9b2e-000000000002",
          "name": "General consultation"
        }
      ],
      "deskId": null,
      "position": 1,
      "slotAt": null,
      "createdAt": "2026-10-30T04:12:00.000Z",
      "calledAt": null,
      "startedAt": null,
      "endedAt": null,
      "updatedAt": "2026-10-30T04:15:00.000Z"
    },
    "changed": [
      "priority"
    ]
  }
}

EVENT `line.paused` #

Arrives as a POST to your endpoint with LineMeUp-Signature , LineMeUp-Event-Id , LineMeUp-Event-Type and LineMeUp-Delivery-Id .

Payload
Field	Type	Notes
`id`required	`string`
`type`required	`string`	Always "line.paused"
`apiVersion`required	`string`	Always "v1"
`createdAt`required	`string (date-time)`
`businessId`required	`string`
`test`required	`boolean`
`data`required	`object`
`data.line`required	`object`
`data.line.id`required	`string`
`data.line.name`required	`string`
`data.line.code`required	`string`
`data.line.type`required	`enum`	One of "walk_in", "appointment", "scheduled_walk_in"
`data.line.paused`required	`boolean`
`data.line.waiting`required	`integer`
`data.line.avgServiceMinutes`required	`integer`
`data.line.maxCapacity`required	`integer`
`data.line.description`required	`string \| null`
`data.line.location`required	`string \| null`
`data.line.callGraceMinutes`required	`integer`
`data.line.appointmentGraceBeforeMinutes`required	`integer`
`data.line.maxLateArrivalMinutes`required	`integer`
`data.line.autoNoShowEnabled`required	`boolean`

Example payload

{
  "id": "evt-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "type": "line.paused",
  "apiVersion": "v1",
  "createdAt": "2026-10-30T06:30:00.000Z",
  "businessId": "bus-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "test": false,
  "data": {
    "line": {
      "id": "line-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "name": "General",
      "code": "GEN",
      "type": "walk_in",
      "paused": true,
      "waiting": 4,
      "avgServiceMinutes": 10,
      "maxCapacity": 60,
      "description": "Walk-ins for a first visit",
      "location": "Ground floor",
      "callGraceMinutes": 5,
      "appointmentGraceBeforeMinutes": 10,
      "maxLateArrivalMinutes": 15,
      "autoNoShowEnabled": true
    }
  }
}

EVENT `line.resumed` #

Arrives as a POST to your endpoint with LineMeUp-Signature , LineMeUp-Event-Id , LineMeUp-Event-Type and LineMeUp-Delivery-Id .

Payload
Field	Type	Notes
`id`required	`string`
`type`required	`string`	Always "line.resumed"
`apiVersion`required	`string`	Always "v1"
`createdAt`required	`string (date-time)`
`businessId`required	`string`
`test`required	`boolean`
`data`required	`object`
`data.line`required	`object`
`data.line.id`required	`string`
`data.line.name`required	`string`
`data.line.code`required	`string`
`data.line.type`required	`enum`	One of "walk_in", "appointment", "scheduled_walk_in"
`data.line.paused`required	`boolean`
`data.line.waiting`required	`integer`
`data.line.avgServiceMinutes`required	`integer`
`data.line.maxCapacity`required	`integer`
`data.line.description`required	`string \| null`
`data.line.location`required	`string \| null`
`data.line.callGraceMinutes`required	`integer`
`data.line.appointmentGraceBeforeMinutes`required	`integer`
`data.line.maxLateArrivalMinutes`required	`integer`
`data.line.autoNoShowEnabled`required	`boolean`

Example payload

{
  "id": "evt-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "type": "line.resumed",
  "apiVersion": "v1",
  "createdAt": "2026-10-30T07:00:00.000Z",
  "businessId": "bus-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "test": false,
  "data": {
    "line": {
      "id": "line-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "name": "General",
      "code": "GEN",
      "type": "walk_in",
      "paused": false,
      "waiting": 4,
      "avgServiceMinutes": 10,
      "maxCapacity": 60,
      "description": "Walk-ins for a first visit",
      "location": "Ground floor",
      "callGraceMinutes": 5,
      "appointmentGraceBeforeMinutes": 10,
      "maxLateArrivalMinutes": 15,
      "autoNoShowEnabled": true
    }
  }
}

EVENT `desk.status_changed` #

Arrives as a POST to your endpoint with LineMeUp-Signature , LineMeUp-Event-Id , LineMeUp-Event-Type and LineMeUp-Delivery-Id .

Payload
Field	Type	Notes
`id`required	`string`
`type`required	`string`	Always "desk.status_changed"
`apiVersion`required	`string`	Always "v1"
`createdAt`required	`string (date-time)`
`businessId`required	`string`
`test`required	`boolean`
`data`required	`object`
`data.desk`required	`object`
`data.desk.id`required	`string`
`data.desk.name`required	`string`
`data.desk.type`required	`enum`	One of "person", "counter"
`data.desk.publicLabel`required	`string \| null`
`data.desk.active`required	`boolean`
`data.desk.state`required	`enum`	One of "offline", "available", "called", "busy", "break"
`data.desk.lineIds`required	`array of string`
`data.from`required	`enum`	One of "offline", "available", "called", "busy", "break"
`data.to`required	`enum`	One of "offline", "available", "called", "busy", "break"

Example payload

{
  "id": "evt-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "type": "desk.status_changed",
  "apiVersion": "v1",
  "createdAt": "2026-10-30T06:30:00.000Z",
  "businessId": "bus-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "test": false,
  "data": {
    "desk": {
      "id": "sta-0193f2a1-7c4e-7a10-9b2e-000000000001",
      "name": "Dr Mehta",
      "type": "person",
      "publicLabel": "Room 1",
      "active": true,
      "state": "break",
      "lineIds": [
        "line-0193f2a1-7c4e-7a10-9b2e-000000000001"
      ]
    },
    "from": "available",
    "to": "break"
  }
}

EVENT `webhook.test` #

Arrives as a POST to your endpoint with LineMeUp-Signature , LineMeUp-Event-Id , LineMeUp-Event-Type and LineMeUp-Delivery-Id .

Payload
Field	Type	Notes
`id`required	`string`
`type`required	`string`	Always "webhook.test"
`apiVersion`required	`string`	Always "v1"
`createdAt`required	`string (date-time)`
`businessId`required	`string`
`test`required	`boolean`
`data`required	`object`
`data.message`required	`string`

Example payload

{
  "id": "evt-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "type": "webhook.test",
  "apiVersion": "v1",
  "createdAt": "2026-10-30T05:00:00.000Z",
  "businessId": "bus-0193f2a1-7c4e-7a10-9b2e-000000000001",
  "test": true,
  "data": {
    "message": "A test event from Line Me Up. Your endpoint is receiving webhooks."
  }
}

API reference

Sample builder#

Business#

GET /business #

Lines#

GET /lines #

PUT /lines #

GET /lines/{lineId} #

PUT /lines/{lineId} #

POST /lines/{lineId}/pause #

POST /lines/{lineId}/resume #

Services#

GET /services #

Desks#

GET /desks #

POST /desks/{deskId}/call-next #

PUT /desks/{deskId}/status #

Visits#

GET /visits #

POST /visits #

GET /visits/{visitId} #

PATCH /visits/{visitId} #

POST /visits/{visitId}/transitions #

POST /visits/{visitId}/urgent #

Webhook events#

EVENT visit.created #

EVENT visit.status_changed #

EVENT visit.updated #

EVENT line.paused #

EVENT line.resumed #

EVENT desk.status_changed #

EVENT webhook.test #

GET `/business` #

GET `/lines` #

PUT `/lines` #

GET `/lines/{lineId}` #

PUT `/lines/{lineId}` #

POST `/lines/{lineId}/pause` #

POST `/lines/{lineId}/resume` #

GET `/services` #

GET `/desks` #

POST `/desks/{deskId}/call-next` #

PUT `/desks/{deskId}/status` #

GET `/visits` #

POST `/visits` #

GET `/visits/{visitId}` #

PATCH `/visits/{visitId}` #

POST `/visits/{visitId}/transitions` #

POST `/visits/{visitId}/urgent` #

EVENT `visit.created` #

EVENT `visit.status_changed` #

EVENT `visit.updated` #

EVENT `line.paused` #

EVENT `line.resumed` #

EVENT `desk.status_changed` #

EVENT `webhook.test` #