Business Unit

GET /business-unit/list

This API is to get all the list of available business unit. This is an authendicated API so we need to pass bearer token in request header to access the data.

Headers

  • Authorization string Required
  • Accept string

Query parameters

  • regions array
  • clients array
  • status string

    active, inactive, lapsed, potential

  • is_deleted boolean

    0 or 1

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • status string
    • data array[object]
      Hide data attributes Show data attributes object
      • id integer
      • client_name string
      • business_unit_name string
      • email string
      • mobile_number string
      • client_id integer
      • ref_code string
      • address_line string
      • has_split_rate integer
      • holiday_split_rate integer
      • client_invoice_milage_rate null
      • candidate_invoice_milage_rate null
      • status string
      • regions array[object]
        Hide regions attributes Show regions attributes object
        • id integer
        • name string
      • portal_access string
    • message string
GET /business-unit/list 
curl \
 --request GET 'https://api-console.logezy.co/v1/business-unit/list' \
 --header "Authorization: Bearer your-access-token" \
 --header "Accept: application/json"
Response examples (200) 
{
  "data": [
    {
      "id": 214,
      "break": null,
      "email": "[email protected]",
      "status": "active",
      "regions": [
        {
          "id": 1,
          "name": "Birmingham"
        }
      ],
      "ref_code": "BU73DE214",
      "client_id": 193,
      "client_name": "A Care",
      "address_line": "Mahatma Gandhi Main Rd, Kanka, Ranchi, Jharkhand 834001, India",
      "mobile_number": "+78 9654-21",
      "portal_access": "no_account",
      "has_split_rate": 1,
      "business_unit_name": "A Care -Flat Rate",
      "holiday_split_rate": 0,
      "client_invoice_milage_rate": null,
      "candidate_invoice_milage_rate": null
    }
  ],
  "status": "success",
  "message": "Business unit list retrieved successfully."
}