> ## Documentation Index > Fetch the complete documentation index at: https://api.docs.originone.ai/llms.txt > Use this file to discover all available pages before exploring further. # List packages > Returns the active packages assigned to the companies linked to the API token or to their locations, ordered by name. Filterable by name and location. Requires the `package.list` scope. ## OpenAPI ````yaml api-reference/openapi.json GET /api/v2/packages openapi: 3.1.0 info: title: Origin One API description: REST API for integrating with the Origin One platform. version: '2' contact: name: Origin One url: https://origin.one email: support@originone.ai servers: - url: https://api.stage.origin.one description: Staging - url: https://api.origin.one description: Production security: [] tags: - name: agencies description: >- Regulatory agencies and the job categories they publish; the same for every API token. - name: jobCategories description: >- Job categories an agency publishes; an order under FAA, FRA or FTA names one. - name: clinics description: Collection sites where participants are tested. - name: companies description: Companies linked to your API token. - name: locations description: Company locations. - name: orders description: >- Drug and alcohol test orders: create them and follow their services to a result. - name: packages description: Packages of services that can be ordered. - name: services description: Services available to your API token. - name: webhooks description: Events delivered to the callback URL given when an order was created. paths: /api/v2/packages: get: tags: - packages summary: List packages description: >- Returns the active packages assigned to the companies linked to the API token or to their locations, ordered by name. Filterable by name and location. Requires the `package.list` scope. operationId: listPackages parameters: - name: limit required: false in: query description: Number of items per page (max 20). schema: default: 10 type: integer minimum: 1 maximum: 20 description: Number of items per page (max 20). example: 10 - name: page required: false in: query description: Page of results to return (1-based). schema: default: 1 type: integer minimum: 1 maximum: 10000 description: Page of results to return (1-based). example: 1 - name: locationId required: false in: query description: >- Filter to the packages a location offers: its own, or its company’s when it has none of its own. A location that is inactive, deleted, or not under a company linked to the API token returns an empty page. schema: example: '456' description: >- Filter to the packages a location offers: its own, or its company’s when it has none of its own. A location that is inactive, deleted, or not under a company linked to the API token returns an empty page. type: string - name: name required: false in: query description: Filter by package name (case-insensitive partial match). schema: type: string minLength: 1 maxLength: 255 description: Filter by package name (case-insensitive partial match). example: pre-employment responses: '200': description: Success. content: application/json: schema: $ref: '#/components/schemas/PackageList' '400': description: The request failed validation. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: The bearer token is missing, invalid, or expired. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: The API token lacks the required scope. content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/Error' security: - bearer: [] components: schemas: PackageList: type: object properties: data: type: array items: $ref: '#/components/schemas/Package' description: Items on this page. limit: type: integer description: Number of items per page. example: 10 page: type: integer description: Current page number (1-based). example: 1 total: type: integer description: Number of matching items across all pages. example: 1 required: - data - limit - page - total Error: type: object properties: error: type: string description: HTTP status reason phrase. example: Bad Request errors: type: array items: type: object properties: code: anyOf: - type: string enum: - backgroundCheckIntegrationNotConfigured - badRequest - conflict - insufficientScope - internalError - invalidElement - invalidFormat - invalidKey - invalidScheduleStrategy - invalidState - invalidType - invalidUnion - invalidValue - linkRequiredBackground - notFound - notMultipleOf - required - scheduleClinicExcludedByFeeCap - scheduleConfiguredClinicUnavailable - tooBig - tooManyRequests - tooSmall - unauthenticated - unrecognizedKeys - type: string description: >- Machine-readable error code. New codes may be added; treat unknown codes by `statusCode`. example: tooSmall detail: type: string description: Human-readable explanation. example: 'Too small: expected number to be >=1' meta: description: Additional machine-readable context. type: object propertyNames: type: string additionalProperties: {} source: description: Present only when a request field is at fault. type: object properties: pointer: type: string description: JSON pointer to the request field at fault. example: /page required: - pointer required: - code - detail description: One entry per problem found. statusCode: type: integer description: HTTP status code. example: 400 required: - error - errors - statusCode Package: type: object properties: id: type: string description: Unique identifier of the package. example: '789' name: type: string description: Package name. example: DOT Pre-Employment Drug Test object: type: string description: Object type; always `package`. example: package enum: - package locationIds: type: array items: type: string description: >- Locations that offer the package, under companies linked to the API token: those it is assigned to, and those that inherit it from their company. example: - '456' services: type: array items: $ref: '#/components/schemas/ServiceReference' description: Services the package includes, ordered by name. url: type: string description: Canonical path of this resource, relative to the API origin. example: /api/v2/packages/789 format: uri-reference required: - id - name - object - locationIds - services - url ServiceReference: type: object properties: id: type: string description: Unique identifier of the service. example: a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11 name: type: string description: Service name. example: 5 Panel Urine Drug Screen object: type: string description: Object type; always `service`. example: service enum: - service type: anyOf: - type: string enum: - additionalService - backgroundCheckService - breathAlcoholTest - clinical - confirmationTest - injuryCareService - instantDrugTest - labBasedToxicology - occupationalHealthService - safetyTraining - vaccination - mroService - unknown - type: string description: Service type. New values may be added. example: labBasedToxicology url: type: string description: Canonical path of this resource, relative to the API origin. example: /api/v2/services/a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11 format: uri-reference required: - id - name - object - type - url securitySchemes: bearer: description: >- Origin One API token. Pass it in the Authorization header: `Authorization: Bearer `. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.