Agency Extensions

Get Agency Capabilities

get

Returns all capabilities related to the agency including item sizes, item weights, and vehicle types available.

Authorizations

Responses

200

Success

application/json

Responseall of

400

Validation Error

application/json

500

Something went wrong

get

HTTPcURLJavaScriptPython

GET /agency/capabilities/ HTTP/1.1
Host: test.swooveapi.com
Authorization: Bearer JWT
Accept: */*

{
  "success": true,
  "code": 200,
  "message": "Estimate completed",
  "responses": {
    "itemSizes": [
      {
        "_id": "text",
        "name": "text",
        "code": "text",
        "description": "text",
        "unit": "text",
        "dimensions": {
          "length": 1,
          "width": 1,
          "height": 1
        },
        "logo": "https://example.com",
        "is_enabled": true,
        "agency_id": "text",
        "country_id": "text",
        "createdAt": "2025-06-27T08:13:09.721Z",
        "updatedAt": "2025-06-27T08:13:09.721Z"
      }
    ],
    "itemWeights": [
      {
        "_id": "text",
        "label": "text",
        "min_weight": 1,
        "max_weight": 1,
        "description": "text",
        "unit": "text",
        "is_enabled": true,
        "is_active": true,
        "agency_id": "text",
        "country_id": "text",
        "createdAt": "2025-06-27T08:13:09.721Z",
        "updatedAt": "2025-06-27T08:13:09.721Z"
      }
    ],
    "vehicleTypes": [
      {
        "_id": "text",
        "name": "text",
        "type": "MOTORCYCLE",
        "is_enabled": true,
        "agency_id": "text",
        "country_id": "text",
        "createdAt": "2025-06-27T08:13:09.721Z",
        "updatedAt": "2025-06-27T08:13:09.721Z"
      }
    ]
  }
}

Get Riders

get

Returns a paginated list of riders (agents) created by the agency.

Authorizations

Query parameters

page_numberintegerOptional

The current page number

Default: 1

limitsintegerOptional

Number of riders to return per page

Default: 10

active_deliveriesbooleanOptional

Filter for agents with active deliveries

Default: false

locationstringOptional

Comma-separated latitude and longitude to sort agents by proximity

Example: 5.6456,-0.1124

Responses

200

Success

application/json

Responseall of

400

Validation Error

application/json

401

Unauthorized

500

Something went wrong

get

HTTPcURLJavaScriptPython

GET /agency/get-riders/ HTTP/1.1
Host: test.swooveapi.com
Authorization: Bearer JWT
Accept: */*

{
  "success": true,
  "code": 200,
  "message": "Estimate completed",
  "responses": {
    "docs": [
      {
        "agent_first_name": "text",
        "agent_last_name": "text",
        "agent_mobile": "text",
        "agent_picture": "text",
        "license_type": "text",
        "license_number": "text",
        "license_expiry": 1
      }
    ],
    "total": 1,
    "limit": 1,
    "page": 1,
    "pages": 1
  }
}