TagMangoTagMango Docs
Consultation Booking

List customer consultation bookings

GET
/api/v1/external/consultation-bookings/{userId}

Omitting pagination returns page 1 with 25 bookings. A page past the end returns an empty data array while total remains unchanged. Pagination is offset-based, so bookings created or reclassified during a multi-page read can shift later pages. Restart from page 1 when a consistent snapshot matters.

This operation is read-only and safe to retry. A booking is returned only while its consultation record exists.

External access policy

An API key and an authorized white-label host are required. Both tier and plan requirements are enforced.

These requirements apply to the white-label creator for backend-to-backend access. TagMango platform access is not supported.

  • Plans: Unrestricted.

  • Tiers: Unrestricted.

AuthorizationBearer <token>

In: header

Path Parameters

userId*string

The customer whose consultation history is returned. Use data[].customer._id from List Subscribers. The customer must belong to the authenticated host; an identifier from another host is reported as not found.

Match^[0-9a-fA-F]{24}$
Length24 <= length <= 24

Query Parameters

limit?integer

Maximum bookings returned on this page. Omit to return 25.

Default25
Range1 <= value <= 50
page?integer

One-based page number. Values below 1 return 400 with "Page number must be greater than or equal to 1".

Range1 <= value
queryType*string

upcoming returns pending bookings dated today or later. previous returns every booking before today plus cancelled or completed bookings dated today or later. Today uses the creator account's stored UTC offset, falling back to +05:30; the slot time does not change group membership.

Value in"upcoming" | "previous"

Header Parameters

x-whitelabel-host*string

Host name of the dashboard, ex: mydomain.tagmango.com

x-timezone-offset?integer

Timezone offset in minutes used only to normalize slot dates for ordering. Omit it to use +05:30. The upcoming and previous groups always use the creator account timezone.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api-prod-new.tagmango.com/api/v1/external/consultation-bookings/66c4964c11e7fef26751f3a7?queryType=upcoming" \  -H "x-whitelabel-host: string"
{
  "data": [
    {
      "bookingId": "66d111111111111111111111",
      "status": "pending",
      "bookedAt": "2026-09-10T08:00:00.000Z",
      "updatedAt": "2026-09-10T08:00:00.000Z",
      "consultation": {
        "_id": "66a222222222222222222222",
        "title": "Career Strategy Call"
      },
      "mango": {
        "_id": "66a1390268a76f2f5c9f39a3",
        "title": "Introduction to Coding"
      },
      "slot": {
        "date": "2026-09-20T00:00:00.000Z",
        "startTime": "10:00",
        "endTime": "10:30",
        "timezoneOffset": "+05:30",
        "timezoneName": "Asia/Kolkata"
      }
    }
  ],
  "total": 8,
  "page": 1,
  "limit": 25
}
{
  "code": 400,
  "type": "Bad Request",
  "statusMessage": "BAD_REQUEST",
  "success": false,
  "message": "Invalid request",
  "result": "Invalid request"
}
{
  "code": 401,
  "type": "Unauthorized",
  "statusMessage": "UNAUTHORIZED",
  "message": "Invalid token",
  "result": "Invalid token",
  "success": false
}
{
  "code": 403,
  "type": "Forbidden",
  "statusMessage": "FORBIDDEN",
  "errorCode": "WORKSHOP_MANGO_FORBIDDEN",
  "message": "You can not access this api with a TagMango account, only available for whitelabel hosts",
  "result": "You can not access this api with a TagMango account, only available for whitelabel hosts",
  "success": false
}
{
  "code": 404,
  "type": "Not Found",
  "statusMessage": "NOT_FOUND",
  "errorCode": "USER_NOT_FOUND",
  "message": "No customer with this ID exists on the authenticated host. A customer belonging to another host is answered identically. Choose a current customer ID and retry.",
  "result": "No customer with this ID exists on the authenticated host. A customer belonging to another host is answered identically. Choose a current customer ID and retry.",
  "success": false
}
{
  "code": 429,
  "type": "Too Many Requests",
  "statusMessage": "TOO_MANY_REQUESTS",
  "message": "Request limit exceeded. try after 10 seconds",
  "result": "Request limit exceeded. try after 10 seconds",
  "success": false
}