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

# List allocations

A resource allocation for a member or placeholder.


## OpenAPI

````yaml openapi.json GET /allocations
openapi: 3.1.0
info:
  title: Ruddr API
  version: '1.0'
  license:
    name: Proprietary
    url: https://www.ruddr.com/master-subscription-agreement
servers:
  - url: https://www.ruddr.io/api/workspace
security:
  - bearerAuth: []
tags:
  - name: Allocations
    description: Manage resource allocations for scheduling team members to projects.
  - name: Availability Periods
    description: Manage member availability periods for capacity planning.
  - name: Business Units
    description: >-
      Manage business units for organizing invoice settings and grouping clients
      and projects.
  - name: Client Roles
    description: Manage client roles and their billing terms.
  - name: Client Tags
    description: Manage tags for categorizing clients.
  - name: Clients
    description: Manage clients and their billing settings.
  - name: Companies
    description: Manage companies in the CRM pipeline.
  - name: Company Spend Tiers
    description: Manage spend tier classifications for companies.
  - name: Company Types
    description: Manage type classifications for companies.
  - name: Contact Tags
    description: Manage tags for categorizing contacts.
  - name: Contacts
    description: Manage contacts associated with clients, companies, and opportunities.
  - name: Cost Periods
    description: Manage member cost rate periods for profitability tracking.
  - name: Credit Notes
    description: View credit notes issued against invoices.
  - name: Disciplines
    description: Manage disciplines for classifying member skill areas.
  - name: Exchange Rate
    description: Get exchange rates for multi-currency workspaces.
  - name: Exchange Rate Periods
    description: Manage custom exchange rate periods for currency conversion.
  - name: Expense Categories
    description: Manage expense categories for tracking and reporting.
  - name: Expense Items
    description: Manage individual expense line items.
  - name: Expense Reports
    description: Manage expense reports submitted by members.
  - name: Holiday Schedules
    description: Manage holiday schedules for capacity and availability planning.
  - name: Holidays
    description: Manage individual holidays within holiday schedules.
  - name: Industries
    description: Manage industry classifications for clients and companies.
  - name: Invoice Items
    description: Manage invoice line item types for billing.
  - name: Invoices
    description: View invoices and their line items.
  - name: Job Titles
    description: Manage job title classifications for members.
  - name: Locations
    description: Manage office locations for members and projects.
  - name: Member Certifications
    description: Manage certification types that can be assigned to members.
  - name: Member Levels
    description: Manage member level classifications for career tracking.
  - name: Member Tags
    description: Manage tags for categorizing members.
  - name: Members
    description: Manage workspace members and their profiles.
  - name: Opportunities
    description: Manage sales opportunities in the CRM pipeline.
  - name: Opportunity Pipelines
    description: Manage pipelines for tracking opportunity stages.
  - name: Opportunity Lead Sources
    description: Manage lead source classifications for opportunities.
  - name: Opportunity Stages
    description: Manage pipeline stage definitions for opportunities.
  - name: Opportunity Tags
    description: Manage tags for categorizing opportunities.
  - name: Opportunity Types
    description: Manage type classifications for opportunities.
  - name: Payment Methods
    description: Manage payment method options for invoices.
  - name: Payments
    description: View payments received against invoices.
  - name: Pipeline Activities
    description: >-
      Manage pipeline activities associated with companies, contacts, members,
      and opportunities.
  - name: Pipeline Activity Types
    description: Manage activity type classifications for pipeline activities.
  - name: Practices
    description: Manage practice area classifications for organizing projects and members.
  - name: Project Budget Expenses
    description: Manage expense budget line items on projects.
  - name: Project Budget Other Items
    description: Manage other budget line items on projects.
  - name: Project Budget Product Items
    description: Manage product budget line items on projects.
  - name: Project Budget Service Items
    description: Manage additional service budget line items on projects.
  - name: Project Expenses
    description: Manage project-level expense line items.
  - name: Project Groups
    description: View project groups for organizing related projects.
  - name: Project Health Reports
    description: Manage project health status reports.
  - name: Project Invoice Milestones
    description: Manage invoice milestones for fixed-fee project billing.
  - name: Project Members
    description: Manage team member assignments on projects.
  - name: Project Monthly Budget Expenses
    description: Manage monthly expense budget line items on projects.
  - name: Project Monthly Budget Other Items
    description: Manage monthly other budget line items on projects.
  - name: Project Monthly Budget Product Items
    description: Manage monthly product budget line items on projects.
  - name: Project Monthly Budget Service Items
    description: Manage monthly additional service budget line items on projects.
  - name: Project Other Items
    description: Manage project-level other item line items.
  - name: Project Product Items
    description: Manage project-level product line items.
  - name: Project Revenue Adjustments
    description: Manage earned revenue adjustments for projects.
  - name: Project Revenue Recognition Entries
    description: Manage revenue recognition entries for projects.
  - name: Project Roles
    description: Manage roles defined on projects for billing and staffing.
  - name: Project Service Items
    description: Manage project-level additional service line items.
  - name: Project Tags
    description: Manage tags for categorizing projects.
  - name: Project Tasks
    description: Manage tasks on projects for time tracking and planning.
  - name: Project Types
    description: Manage type classifications for projects.
  - name: Projects
    description: Manage projects and their settings.
  - name: Resource Placeholders
    description: Manage placeholder resources for allocation planning.
  - name: Security Roles
    description: View security roles for assigning member permissions.
  - name: Skills
    description: Manage skill classifications for members and resource planning.
  - name: Task Categories
    description: Manage task category classifications for project tasks.
  - name: Task Tags
    description: Manage tags for categorizing project tasks.
  - name: Task Templates
    description: Manage reusable task templates for projects.
  - name: Tax Rates
    description: Manage tax rates for invoicing.
  - name: Time Entries
    description: Manage time entries for tracking hours on projects.
  - name: Time Off Types
    description: Manage time off type classifications.
  - name: Timesheet Attestations
    description: Manage attestation statements members sign when submitting timesheets.
  - name: Timesheets
    description: Manage timesheet submissions for tracking hours across a period.
  - name: Utilization Target Periods
    description: Manage member utilization target periods for capacity planning.
  - name: Workspace Roles
    description: Manage workspace-level roles for billing rate configuration.
paths:
  /allocations:
    get:
      tags:
        - Allocations
      summary: List allocations
      operationId: list-allocations
      parameters:
        - $ref: '#/components/parameters/StartingAfter'
        - $ref: '#/components/parameters/EndingBefore'
        - $ref: '#/components/parameters/Limit'
        - name: assignmentTypeId
          in: query
          description: >-
            Filter by the assignment type of the allocation. Can be either
            `"project"` (Project) or `"time_off"` (Time Off).
          schema:
            type: string
            enum:
              - project
              - time_off
        - name: memberId
          in: query
          description: A member ID (uuid) used to filter allocations for a specific member.
          schema:
            type: string
        - name: startBefore
          in: query
          description: >-
            A filter on the list based on the allocation's `start` field in the
            format `YYYY-MM-DD`. This will match dates before (`<`) the date
            specified.
          schema:
            type: string
            format: date
        - name: startOnBefore
          in: query
          description: >-
            A filter on the list based on the allocation's `start` field in the
            format `YYYY-MM-DD`. This will match dates on and before (`<=`) the
            date specified.
          schema:
            type: string
            format: date
        - name: endAfter
          in: query
          description: >-
            A filter on the list based on the allocation's `end` field in the
            format `YYYY-MM-DD`. This will match dates after (`>`) the date
            specified.
          schema:
            type: string
            format: date
        - name: endOnAfter
          in: query
          description: >-
            A filter on the list based on the allocation's `end` field in the
            format `YYYY-MM-DD`. This will match dates on and after (`>=`) the
            date specified.
          schema:
            type: string
            format: date
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    description: The list of results for the current page.
                    items:
                      $ref: '#/components/schemas/Allocation'
                  hasMore:
                    type: boolean
                    description: Whether there are more results available after this page.
              examples:
                Result:
                  value:
                    results:
                      - id: 3f8a1d2e-7c4b-4e9f-a6d5-1b2c3d4e5f6a
                        resourceTypeId: member
                        assignmentTypeId: project
                        start: '2025-03-01'
                        end: '2025-05-31'
                        unit: day
                        hoursPerDay: 6.5
                        hoursPerWeek: null
                        hoursPerMonth: null
                        hoursPerAllocation: null
                        hoursRatioOfCapacity: null
                        allocateOnTimeOffDays: false
                        totalHours: 422.5
                        isBillable: true
                        bookingTypeId: confirmed
                        notes: Q2 product roadmap delivery
                        readOnly: false
                        entity: allocation
                        createdAt: '2025-01-10T14:22:35.418Z'
                        member:
                          id: 9b7e6d5c-4a3f-4b2e-8c1d-0e9f8a7b6c5d
                          name: Jane Smith
                        placeholder: null
                        project:
                          id: c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f
                          name: Website Redesign
                          client:
                            id: 7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d
                            name: Acme Corp
                        role:
                          id: d4e5f6a7-b8c9-4d0e-af1b-2c3d4e5f6a7b
                          name: Senior Engineer
                        task:
                          id: e5f6a7b8-c9d0-4e1f-b2a3-4c5d6e7f8a9b
                          name: Backend Development
                        timeOffType: null
                    hasMore: false
        '400':
          description: '400'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InvalidId:
                  value:
                    status: 400
                    message: Parameter 'startingAfter' is not a valid UUID.
        '403':
          description: '403'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Feature:
                  value:
                    status: 403
                    message: Feature 'Resource Allocations' is not enabled.
      deprecated: false
components:
  parameters:
    StartingAfter:
      name: startingAfter
      in: query
      description: >-
        A cursor ID (`uuid`) used to request the next page of results. If not
        provided, defaults to the first page of results.
      schema:
        type: string
    EndingBefore:
      name: endingBefore
      in: query
      description: >-
        A cursor ID (`uuid`) used to request the previous page of results. Is
        mutually exclusive with `startingAfter`.
      schema:
        type: string
    Limit:
      name: limit
      in: query
      description: >-
        The maximum number of results to be returned. Can be any number from 1
        to 100. Defaults to 10, if not provided.
      schema:
        type: integer
  schemas:
    Allocation:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the object.
        resourceTypeId:
          type: string
          description: The type of resource assigned to this allocation.
          enum:
            - member
            - placeholder
        assignmentTypeId:
          type: string
          description: The type of assignment for this allocation.
          enum:
            - project
            - time_off
        start:
          type: string
          format: date
          description: The start date of the allocation. Will be in the form YYYY-MM-DD.
        end:
          type: string
          format: date
          description: The end date of the allocation. Will be in the form YYYY-MM-DD.
        unit:
          type: string
          description: The time unit that determines how the allocation is measured.
          enum:
            - day
            - week
            - month
            - allocation
            - ratio_of_capacity
        hoursPerDay:
          type:
            - number
            - 'null'
          description: >-
            The number of hours allocated per day. Only present when `unit` is
            `"day"`, otherwise `null`.
        hoursPerWeek:
          type:
            - number
            - 'null'
          description: >-
            The number of hours allocated per week. Only present when `unit` is
            `"week"`, otherwise `null`.
        hoursPerMonth:
          type:
            - number
            - 'null'
          description: >-
            The number of hours allocated per month. Only present when `unit` is
            `"month"`, otherwise `null`.
        hoursPerAllocation:
          type:
            - number
            - 'null'
          description: >-
            The total number of hours for the entire allocation duration. Only
            present when `unit` is `"allocation"`, otherwise `null`.
        hoursRatioOfCapacity:
          type:
            - number
            - 'null'
          description: >-
            The proportion of the member's available capacity allocated. Only
            present when `unit` is `"ratio_of_capacity"`, otherwise `null`.
        allocateOnTimeOffDays:
          type:
            - boolean
            - 'null'
          description: >-
            Whether time is allocated on days when the member has time off. Only
            present when `assignmentTypeId` is `"project"` and `resourceTypeId`
            is `"member"`, otherwise `null`.
        totalHours:
          type: number
          description: >-
            The total number of computed hours across all dates in the
            allocation.
        isBillable:
          type: boolean
          description: Whether this allocation is billable.
        bookingTypeId:
          type: string
          enum:
            - confirmed
            - soft
          description: The booking type of the allocation.
        notes:
          type:
            - string
            - 'null'
          description: Notes associated with the allocation.
        readOnly:
          type: boolean
          description: >-
            Whether this allocation is read-only. Allocations sourced from time
            entries or holidays are read-only.
        entity:
          type: string
          description: The source entity type.
          enum:
            - allocation
            - time_entry
            - holiday
        createdAt:
          type: string
          format: date-time
          description: The timestamp when the object was created.
        member:
          type:
            - object
            - 'null'
          description: >-
            The member assigned to this allocation. Present when
            `resourceTypeId` is `"member"`, otherwise `null`.
          properties:
            id:
              type: string
              description: The unique identifier for the object.
            name:
              type: string
              description: The name of the member.
        placeholder:
          type:
            - object
            - 'null'
          description: >-
            The resource placeholder assigned to this allocation. Present when
            `resourceTypeId` is `"placeholder"`, otherwise `null`.
          properties:
            id:
              type: string
              description: The unique identifier for the object.
            name:
              type: string
              description: The name of the resource placeholder.
        project:
          type:
            - object
            - 'null'
          description: >-
            The project this allocation is assigned to. Present when
            `assignmentTypeId` is `"project"`, otherwise `null`.
          properties:
            id:
              type: string
              description: The unique identifier for the object.
            name:
              type: string
              description: The name of the project.
            client:
              type: object
              description: The client associated with the project.
              properties:
                id:
                  type: string
                  description: The unique identifier for the object.
                name:
                  type: string
                  description: The name of the client.
        role:
          type:
            - object
            - 'null'
          description: The project role associated with this allocation, if any.
          properties:
            id:
              type: string
              description: The unique identifier for the object.
            name:
              type: string
              description: The name of the project role.
        task:
          type:
            - object
            - 'null'
          description: The project task associated with this allocation, if any.
          properties:
            id:
              type: string
              description: The unique identifier for the object.
            name:
              type: string
              description: The name of the project task.
        timeOffType:
          type:
            - object
            - 'null'
          description: >-
            The time off type associated with this allocation. Present when
            `assignmentTypeId` is `"time_off"`, otherwise `null`.
          properties:
            id:
              type: string
              description: The unique identifier for the object.
            name:
              type: string
              description: The name of the time off type.
    ErrorResponse:
      type: object
      properties:
        status:
          type: integer
          description: The HTTP status code.
        message:
          type: string
          description: A human-readable error message.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````