> ## Documentation Index
> Fetch the complete documentation index at: https://docs.erp.arukz.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List purchase agreements

> Retrieve a paginated list of purchase agreements with filtering and sorting



## OpenAPI

````yaml /api-reference/openapi.json get /admin/api/v1/purchases/purchase-agreements
openapi: 3.0.3
info:
  title: ARUKZ ERP API
  version: v1
  description: >-
    The REST API of ARUKZ ERP: sales, purchases, inventory, products, partners,
    accounts, projects and reference data. Every call acts as the user whose
    token it carries and sees only that user's company.
servers:
  - url: https://erp.arukz.com
    description: ARUKZ ERP (hosted)
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: Sign in for a token and sign out.
  - name: Sales
    description: Quotations, sales orders and their lines, deliveries and invoices.
  - name: Purchases
    description: Purchase orders, receipts, bills, agreements and vendor price lists.
  - name: Inventory
    description: >-
      Warehouses, locations, lots, stock quantities, receipts, deliveries,
      transfers and scrap.
  - name: Products
    description: 'The product catalogue: categories, attributes, variants and packaging.'
  - name: Partners
    description: Customers, vendors, contacts, addresses and bank accounts.
  - name: Accounts
    description: >-
      Invoices, bills, credit notes, refunds, taxes, journals and the chart of
      accounts.
  - name: Projects
    description: Projects, tasks, stages and milestones.
  - name: Reference data
    description: Currencies and rates, banks, countries, states and units of measure.
paths:
  /admin/api/v1/purchases/purchase-agreements:
    get:
      tags:
        - Purchases
      summary: List purchase agreements
      description: >-
        Retrieve a paginated list of purchase agreements with filtering and
        sorting
      operationId: purchases-purchase-agreements-list-purchase-agreements
      parameters:
        - name: include
          in: query
          required: false
          schema:
            type: string
            description: >-
              Comma-separated list of relationships to include.


              **Available options:** currency, partner, user, company, creator,
              lines, lines.requisition, lines.product, lines.uom, lines.company,
              lines.creator
            example: partner,lines
          description: >-
            Comma-separated list of relationships to include.


            **Available options:** currency, partner, user, company, creator,
            lines, lines.requisition, lines.product, lines.uom, lines.company,
            lines.creator
        - name: filter[id]
          in: query
          required: false
          schema:
            type: string
            description: Comma-separated list of IDs to filter by
          description: Comma-separated list of IDs to filter by
        - name: filter[state]
          in: query
          required: false
          schema:
            type: string
            description: Filter by agreement state
            example: draft
          description: Filter by agreement state
        - name: filter[type]
          in: query
          required: false
          schema:
            type: string
            description: Filter by agreement type
            example: blanket_order
          description: Filter by agreement type
        - name: filter[partner_id]
          in: query
          required: false
          schema:
            type: string
            description: Filter by vendor IDs
          description: Filter by vendor IDs
        - name: filter[trashed]
          in: query
          required: false
          schema:
            type: string
            description: |-
              Filter by trashed status.

              **Available options:** with, only
            example: with
          description: |-
            Filter by trashed status.

            **Available options:** with, only
        - name: sort
          in: query
          required: true
          schema:
            type: string
            description: Sort field
            example: '-created_at'
          description: Sort field
        - name: page
          in: query
          required: true
          schema:
            type: integer
            description: Page number
            example: 1
          description: Page number
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  - id: null
                    name: PA-3683
                    type: blanket_order
                    state: draft
                    reference: null
                    starts_at: null
                    ends_at: null
                    description: null
                    currency_id: 787
                    partner_id: 1
                    user_id: null
                    company_id: 1394
                    creator_id: 1
                    created_at: null
                    updated_at: null
                    deleted_at: null
                  - id: null
                    name: PA-5307
                    type: blanket_order
                    state: draft
                    reference: null
                    starts_at: null
                    ends_at: null
                    description: null
                    currency_id: 788
                    partner_id: 1
                    user_id: null
                    company_id: 1395
                    creator_id: 1
                    created_at: null
                    updated_at: null
                    deleted_at: null
                links:
                  first: /?page=1
                  last: /?page=1
                  prev: null
                  next: null
                meta:
                  current_page: 1
                  from: 1
                  last_page: 1
                  links:
                    - url: null
                      label: '« Previous'
                      active: false
                    - url: /?page=1
                      label: '1'
                      active: true
                    - url: null
                      label: Next »
                      active: false
                  path: /
                  per_page: 10
                  to: 2
                  total: 2
        '401':
          description: Unauthenticated
          content:
            application/json:
              example:
                message: Unauthenticated.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API token from [Sign in](/api-reference/authentication), sent as
        `Authorization: Bearer <token>`. Tokens last 30 days.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.