OpenApi
  1. Branches
  • Branches
    • List active branches
      GET
    • Get a single branch
      GET
    • Get a branch's service tree
      GET
  • Services
    • Get available appointment slots
      GET
  • Tickets
    • Book a ticket (walk-in or appointment)
      POST
    • Fetch a ticket
      GET
    • Cancel a ticket
      POST
    • Reschedule an appointment
      POST
  • Customers
    • Create a customer
      POST
    • List customers (paginated)
      GET
    • Fetch one customer
      GET
    • Update a customer
      PUT
    • Delete a customer
      DELETE
    • List a customer's tickets
      GET
  • Schemas
    • SuccessEnvelope
    • PaginatedEnvelope
    • ErrorEnvelope
    • ValidationErrorEnvelope
    • AuthErrorEnvelope
    • Pagination
    • Branch
    • AvgWaitingTime
    • Service
    • SampleSize
    • BranchDetail
    • Slot
    • Ticket
    • BranchTreeGroup
    • Customer
    • CustomerWriteRequest
    • CustomerUpdateRequest
    • BookTicketRequest
    • ChangeTimeRequest
  1. Branches

Get a branch's service tree

GET
/v1/branches/{branchId}/tree
Returns the service groups of a branch and the active services inside each
group (a two-level tree), together with the branch's current estimated waiting time.
Use it to render a service picker for the chosen branch and to discover, per service,
whether it is currently open (isOpen) and whether it supports appointment booking
(isAppointment).
When to use — After the user picks a branch, to list bookable services.
Prerequisites — A branchId returned by GET /branches that belongs to your
company.
Behavioural notes
data is an object (avgWaitingTime, sampleSize, groups), not a bare array.
Only active service groups (type = service) and active services are included.
Groups whose services are all inactive/empty are omitted from the response.
isAppointment = true means the service can be booked for a specific time via
GET /services/{id}/slots + POST /tickets/book with a time.
Group and service name are localized to X-Locale where translations exist.
avgWaitingTime and sampleSize describe the branch as a whole and are the same
values returned by GET /branches/{branchId}. There is no per-service waiting time.
See that endpoint for how to present them — in particular, do not display
avgWaitingTime when sampleSize is 0.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Path Params

Header Params

Responses

🟢200
application/json
Branch tree fetched successfully.
Bodyapplication/json

🟠422
🟠401Unauthorized
🔴500ServerError
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.skiplino.com/external/v1/branches/802b33af66/tree' \
--header 'X-Locale;' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Success
{
    "message": "Branch tree fetched successfully.",
    "data": {
        "avgWaitingTime": 18,
        "sampleSize": 51,
        "groups": [
            {
                "id": "7c1f9a3b2d",
                "name": "Teller Services",
                "isMain": true,
                "services": [
                    {
                        "id": "6fe8fb8b12",
                        "name": "Cash Withdrawal",
                        "character": "Q",
                        "isOpen": true,
                        "isAppointment": false
                    },
                    {
                        "id": "802b33af66",
                        "name": "Account Opening",
                        "character": "A",
                        "isOpen": true,
                        "isAppointment": true
                    }
                ]
            }
        ]
    }
}
Previous
Get a single branch
Next
Get available appointment slots
Built with