# List workspace rates

Retrieve all rates from the workspace

Endpoint: GET /rates
Version: 1.0.0
Security: ApiKeyAuth

## Query parameters:

  - `expands` (array)
    Expand related data in the response
    Enum: "contact"

  - `search` (string)
    Search rates by name, description, or note
    Example: "camera"

  - `limit` (integer)
    Maximum number of results to return
    Example: 50

  - `offset` (integer)
    Number of results to skip for pagination

## Response 200 fields (application/json):

  - `rates` (array)

  - `rates.id` (string, required)
    Unique item identifier
    Example: "item-001"

  - `rates.name` (string,null)
    Item display name
    Example: "Director of Photography"

  - `rates.emoji` (string,null)
    Item emoji or icon
    Example: "👨‍💻"

  - `rates.description` (string,null)
    Item description
    Example: "Cinematography and camera operation"

  - `rates.note` (string,null)
    Additional notes about the item
    Example: "Includes equipment setup and operation"

  - `rates.quantity` (number,null)
    Item quantity
    Example: 40

  - `rates.rate` (number,null)
    Item rate or cost per unit
    Example: 175

  - `rates.unit` (string,null)
    Unit of measurement
    Enum: "hour", "day", "week", "month", "year", "each", "sqft", "sqm", "lnft", "lnm"

  - `rates.multiplier` (number,null)
    Rate multiplier
    Example: 1.5

  - `rates.contactId` (string,null)
    Associated contact ID
    Example: "contact-dp-001"

  - `rates.contact` (object)

  - `rates.contact.id` (string, required)
    Contact identifier
    Example: "contact-studio-001"

  - `rates.contact.contactTitle` (string,null)
    Contact display title
    Example: "Sunset Studios - Production Company"

  - `rates.contact.name` (string,null)
    Contact name
    Example: "Alex Rivera"

  - `rates.contact.email` (string,null)
    Contact email address
    Example: "alex.rivera@sunsetstudios.com"

  - `rates.contact.company` (string,null)
    Contact company
    Example: "Sunset Studios Inc."

  - `rates.contact.type` (string,null)
    Contact type (Person, Company, etc.)
    Example: "Person"

  - `rates.contact.jobTitle` (string,null)
    Contact job title
    Example: "Director of Photography"

  - `rates.contact.rate` (number,null)
    Contact hourly rate
    Example: 150

  - `rates.contact.secureInfo` (object)

  - `rates.contact.secureInfo.address` (string,null)
    Contact address
    Example: "123 Sunset Blvd, Los Angeles, CA 90028"

  - `rates.contact.secureInfo.phone` (string,null)
    Contact phone number
    Example: "310-555-1234"

  - `rates.contact.secureInfo.taxIdLast4` (string,null)
    Last 4 digits of tax ID
    Example: "4567"

  - `rates.contact.origin` (object)

  - `rates.contact.origin.origin` (string,null)
    How the contact was created
    Enum: "onboarding", "manual"

  - `rates.contact.origin.createdAt` (string,null)
    Contact creation timestamp
    Example: "2024-02-15T08:00:00Z"

  - `rates.contact.origin.createdByUser` (object)

  - `rates.contact.origin.createdByUser.id` (string, required)
    User identifier
    Example: "user-001"

  - `rates.contact.origin.createdByUser.name` (string, required)
    User name
    Example: "Sarah Chen"

  - `rates.contact.origin.createdByUser.email` (string, required)
    User email address
    Example: "sarah.chen@sunsetstudios.com"

  - `rates.contact.startwork` (array)
    Startwork agreements

  - `rates.contact.startwork.id` (string, required)
    Startwork agreement identifier
    Example: "startwork-001"

  - `rates.contact.startwork.title` (string, required)
    Agreement title
    Example: "Independent Contractor Agreement"

  - `rates.contact.startwork.signedOn` (string, required)
    Signature timestamp
    Example: "2024-03-01T10:00:00Z"

  - `rates.contact.linkedUser` (object)

  - `rates.contact.bankInfo` (array)
    Banking information

  - `rates.contact.bankInfo.id` (string, required)
    Bank account identifier
    Example: "bank-acc-001"

  - `rates.contact.bankInfo.bankName` (string, required)
    Bank name
    Example: "Chase Bank"

  - `rates.contact.bankInfo.accountType` (string, required)
    Account type (checking, savings, etc.)
    Example: "checking"

  - `rates.contact.bankInfo.accountLast4` (string, required)
    Last 4 digits of account number
    Example: "4567"

  - `rates.contact.taxDocuments` (array)
    Tax documents

  - `rates.contact.taxDocuments.id` (string, required)
    File identifier (DigitalOcean Spaces object key)
    Example: "files/2024/03/budget-report.pdf"

  - `rates.contact.taxDocuments.name` (string, required)
    Original filename
    Example: "call-sheet-day-3.pdf"

  - `rates.contact.taxDocuments.type` (string, required)
    MIME type
    Example: "application/pdf"

  - `rates.contact.taxDocuments.size` (integer, required)
    File size in bytes
    Example: 1048576

  - `rates.contact.attachments` (array)
    File attachments

  - `rates.contact.projects` (object)
    Associated projects

## Response 401 fields (application/json):

  - `error` (string, required)
    Error message
    Example: "Invalid request parameters"

  - `details` (object)
    Additional error details
    Example: {"field":"projectId","reason":"Project not found"}

  - `code` (string)
    Error code
    Example: "VALIDATION_ERROR"

## Response 500 fields (application/json):

  - `error` (string, required)
    Error message
    Example: "Invalid request parameters"

  - `details` (object)
    Additional error details
    Example: {"field":"projectId","reason":"Project not found"}

  - `code` (string)
    Error code
    Example: "VALIDATION_ERROR"