---
title: "Search packages"
method: GET
path: "/v1/Packages"
tags: ["Packages"]
---

# Search packages

`GET /v1/Packages`

Search for one or more packages.

## Query parameters

- `search.package_id` integer[]
- `search.description` string[]
- `search.provider_id` integer[]
- `search.class` 'Business' | 'Residential'
- `search.active` boolean
- `search.created_date_start` string, date-time
- `search.created_date_end` string, date-time
- `search.state` string[]
- `search.currency_code` string[]
- `search.page_size` integer
- `search.page` integer
- `search.sort` string

## Response `200`

OK

- RevWebAPIModelsGetOrSearchOfRevAppSearchModelsResponseOfRevAppModelsPackage
  - `ok` boolean
  - `has_more` boolean — Helper for pagination. Indicates there are more records returned.
  - `record_count` integer — Total number of records found by the search.
  - `records` RevAppModelsPackage[] — List of records returned.
    - `package_id` integer — Primary identifier for a specific package.
    - `provider_id` integer, required — Foreign key identifier for associated provider.
    - `description` string, required — Short descriptive text that only appears within Rev.io and is not intended to be public facing.
    - `description_on_bill` string, required — Descriptive text that will appear on the bill, or in other words, customers can see this.
    - `long_description` string — Longer descriptive text for further details about the package.
    - `created_date` string, date-time — The date and time this package was added to Rev.io.
    - `created_by` integer — Foreign key identifier for the user who created this package.
    - `active` boolean — Indicates whether this package is active or not.
    - `usage_plan_group_id` integer, required — Foreign key identifier for the usage plan group associated with this package.
    - `service_type_id` integer — Foreign key identifier for the associated service type.
    - `package_category_id` integer — Foreign key identifier for the package category.
    - `exempt_from_spiff_commission` boolean — Indicates package is exempt from Spiff Commission.
    - `state_provinces` string[] — Restricts this package to a list of states and/or provinces (2-Character abbreviation).
    - `postal_codes` string[] — Restricts this package to a list of postal codes.
    - `restrict_class_flag` boolean — Indicates package has a customer class restriction.
    - `class` 'Business' | 'Residential' — Customer class package is restricted to.
    - `restrict_bill_profile_flag` boolean — Indicates package has a bill profile restriction.
    - `bill_profile_id` integer — Bill profile package is restricted to.
    - `links` RevAppComponentsLink[]
      - `rel` string
      - `href` string

## Other responses

- `500` — InternalServerError

---

[API](https://skmtc.net/rev-io/apis/rev-io-api.md) · [All operations](https://skmtc.net/rev-io/apis/rev-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rev-io/rev-io-api/revisions/135571434f6c/schema)