Agave

opencollection: 1.0.0
info:
  name: Agave Unified Construction API
  version: '1.0'
request:
  auth:
    type: apikey
    key: API-Key
    value: '{{API-Key}}'
    placement: header
items:
- info:
    name: Projects
    type: folder
  items:
  - info:
      name: Agave List Projects
      type: http
    http:
      method: GET
      url: https://api.agaveapi.com/v1/projects
      headers:
      - name: source_system_id
        value: linked-account-abc123
      params:
      - name: limit
        value: '100'
        type: query
        description: Maximum number of results to return.
      - name: cursor
        value: eyJpZCI6MTIzfQ==
        type: query
        description: Pagination cursor for the next page of results.
    docs: Retrieve a list of construction projects from the linked source system.
  - info:
      name: Agave Get Project
      type: http
    http:
      method: GET
      url: https://api.agaveapi.com/v1/projects/:id
      headers:
      - name: source_system_id
        value: linked-account-abc123
      params:
      - name: id
        value: proj-500123
        type: path
        description: Project identifier.
    docs: Retrieve a specific construction project by ID.
- info:
    name: Budgets
    type: folder
  items:
  - info:
      name: Agave List Budgets
      type: http
    http:
      method: GET
      url: https://api.agaveapi.com/v1/budgets
      headers:
      - name: source_system_id
        value: linked-account-abc123
      params:
      - name: project_id
        value: proj-500123
        type: query
        description: Filter budgets by project ID.
      - name: limit
        value: '100'
        type: query
        description: Maximum number of results to return.
    docs: Retrieve budget line items for projects in the linked source system.
- info:
    name: Contracts
    type: folder
  items:
  - info:
      name: Agave List Contracts
      type: http
    http:
      method: GET
      url: https://api.agaveapi.com/v1/contracts
      headers:
      - name: source_system_id
        value: linked-account-abc123
      params:
      - name: project_id
        value: proj-500123
        type: query
        description: Filter by project ID.
    docs: Retrieve prime contracts from the linked source system.
- info:
    name: Vendors
    type: folder
  items:
  - info:
      name: Agave List Vendors
      type: http
    http:
      method: GET
      url: https://api.agaveapi.com/v1/vendors
      headers:
      - name: source_system_id
        value: linked-account-abc123
      params:
      - name: limit
        value: '100'
        type: query
        description: Maximum number of results to return.
    docs: Retrieve vendors and subcontractors from the linked source system.
- info:
    name: Cost Codes
    type: folder
  items:
  - info:
      name: Agave List Cost Codes
      type: http
    http:
      method: GET
      url: https://api.agaveapi.com/v1/cost-codes
      headers:
      - name: source_system_id
        value: linked-account-abc123
      params:
      - name: project_id
        value: proj-500123
        type: query
        description: Filter cost codes by project ID.
    docs: Retrieve job cost codes from the linked source system.
- info:
    name: Invoices
    type: folder
  items:
  - info:
      name: Agave List Invoices
      type: http
    http:
      method: GET
      url: https://api.agaveapi.com/v1/invoices
      headers:
      - name: source_system_id
        value: linked-account-abc123
      params:
      - name: project_id
        value: proj-500123
        type: query
        description: Filter by project ID.
    docs: Retrieve accounts payable invoices from the linked source system.
  - info:
      name: Agave Create Invoice
      type: http
    http:
      method: POST
      url: https://api.agaveapi.com/v1/invoices
      headers:
      - name: source_system_id
        value: linked-account-abc123
      body:
        type: json
        data: '{}'
    docs: Create a new accounts payable invoice in the linked source system.
- info:
    name: Timesheets
    type: folder
  items:
  - info:
      name: Agave List Timesheets
      type: http
    http:
      method: GET
      url: https://api.agaveapi.com/v1/timesheets
      headers:
      - name: source_system_id
        value: linked-account-abc123
      params:
      - name: project_id
        value: proj-500123
        type: query
        description: Filter timesheets by project ID.
      - name: date_from
        value: '2025-01-01'
        type: query
        description: Start date for timesheet filter (YYYY-MM-DD).
      - name: date_to
        value: '2025-01-31'
        type: query
        description: End date for timesheet filter (YYYY-MM-DD).
    docs: Retrieve employee timesheets from the linked source system.
- info:
    name: Employees
    type: folder
  items:
  - info:
      name: Agave List Employees
      type: http
    http:
      method: GET
      url: https://api.agaveapi.com/v1/employees
      headers:
      - name: source_system_id
        value: linked-account-abc123
      params:
      - name: limit
        value: '100'
        type: query
        description: Maximum number of results to return.
    docs: Retrieve employee records from the linked source system.
- info:
    name: Link Sessions
    type: folder
  items:
  - info:
      name: Agave Create Link Session
      type: http
    http:
      method: POST
      url: https://api.agaveapi.com/v1/link-sessions
      body:
        type: json
        data: '{}'
    docs: Create a new Agave Link session token for a user to authenticate with a source system.
bundled: true