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 single branch

GET
/v1/branches/{branchId}
Returns a single branch with its live open/closed status and the estimated waiting
time
customers are currently experiencing there.
When to use — Render a branch detail screen, or show how busy a branch is before a
customer travels to it or books, without re-fetching the whole branch list.
Prerequisites — A branchId returned by GET /branches that belongs to your company.
What you get
avgWaitingTime — the typical wait at this branch right now, in whole minutes.
sampleSize — how much recent activity the estimate is based on; use it as a
confidence signal.
branchStatus.isBranchOpen — whether the branch is open at this moment.
What you need to handle
When sampleSize is 0, do not display avgWaitingTime. There has not been
enough recent activity to estimate a wait — show something like “No wait information
available” instead. avgWaitingTime is never 0, so it cannot be used on its own to
detect this case.
A low sampleSize (roughly under 5) means the estimate rests on very few visits and
may move noticeably between calls. Present it as approximate, or suppress it.
Treat the figure as guidance, not a guarantee. It reflects current conditions and
changes through the day.
The value refreshes periodically rather than on every request, so polling faster than
once a minute will not return a fresher number.
Branch name is localized to X-Locale where a translation exists.

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 fetched successfully.
Bodyapplication/json

🟠404
🟠422
🟠401Unauthorized
🔴500ServerError
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.skiplino.com/external/v1/branches/802b33af66' \
--header 'X-Locale;' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Success
{
    "message": "Branch fetched successfully.",
    "data": {
        "branch": {
            "id": "802b33af66",
            "name": "Seef Mall Branch",
            "addressLine": "Seef District, Manama, Bahrain",
            "location": {
                "lat": 26.2361,
                "lng": 50.5436
            },
            "group": {
                "id": "grpseef0001",
                "name": "Capital Region"
            },
            "branchStatus": {
                "isBranchOpen": true
            },
            "avgWaitingTime": 18,
            "sampleSize": 51
        }
    }
}
Previous
List active branches
Next
Get a branch's service tree
Built with