Skip to main content
GET
/
packages
List all packages
curl --request GET \
  --url https://{your-workspace}.neetocal.com/api/external/v1/packages \
  --header 'X-Api-Key: <x-api-key>'
{
  "packages": [
    {
      "id": "aff17ff8-1bf8-4e77-a3c5-2f86104f9a20",
      "name": "Consultation Package",
      "slug": "consultation-package",
      "status": "enabled",
      "duration": 7200,
      "fee": {
        "id": "1b217cc5-69b5-4fb1-a13c-c22f9c14e7f9",
        "amount": "120.0",
        "currency": "inr",
        "feeable_id": "aff17ff8-1bf8-4e77-a3c5-2f86104f9a20",
        "feeable_type": "Package",
        "payment_provider": "cash",
        "kind": "fixed",
        "min_amount": "120.0",
        "taxes": [
          {}
        ],
        "is_default": true,
        "display_amount": "<string>",
        "is_tax_enabled": true,
        "is_tip_enabled": true,
        "is_tax_applicable_on_tip": true,
        "vpas": [
          {}
        ],
        "amount_in_smallest_currency_unit": 12000
      }
    }
  ],
  "pagination": {
    "total_records": 123,
    "total_pages": 123,
    "current_page_number": 123,
    "page_size": 123
  }
}
Replace {your-workspace} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

​
X-Api-Key
string
required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Query Parameters

​
page_number
integer

Retrieve paginated results by specifying the desired page number. If this parameter is absent, all results will be returned.

​
page_size
integer

Set the number of results returned in the response. Defaulting to 30 when omitted.

Response

200 - application/json

OK - Request succeeded

​
packages
object[]

Array of packages available in the workspace, each containing fee configuration and package details.

​
pagination
object

Pagination information including total records, pages, and current page details.