---
title: "List cost periods"
method: GET
path: "/cost-periods"
tags: ["Cost Periods"]
---

# List cost periods

`GET /cost-periods`

## Request

- Base URL: `https://www.ruddr.io/api/workspace`
- URL: `https://www.ruddr.io/api/workspace/cost-periods`
- Auth: HTTP bearer

## Query parameters

- `startingAfter` string
- `endingBefore` string
- `limit` integer
- `memberId` string

## Response `200`

200

- object
  - `results` CostPeriod[]: The list of results for the current page.
    - `id` string: The unique identifier for the object.
    - `isDefault` boolean: Whether this is the default cost period for the member.
    - `start` string, date: The start date for the period. Will be in the form YYYY-MM-DD.
    - `end` string, date, nullable: The end date for the period. Will be in the form YYYY-MM-DD. `null` if this is the most recent period.
    - `currency` string: The currency code for the cost period.
    - `costMethodId` 'hourly' | 'fixed_hourly' | 'fixed_monthly': The cost method used for this period.
    - `costPerHour` number, nullable: The labor cost per hour. `null` when `costMethodId` is `fixed_monthly`.
    - `overheadCostPerHour` number, nullable: The overhead cost per hour. `null` when `costMethodId` is `fixed_monthly`.
    - `totalCostPerHour` number, nullable: The sum of `costPerHour` and `overheadCostPerHour`. `null` when `costMethodId` is `fixed_monthly`.
    - `costPerMonth` number, nullable: The labor cost per month. `null` when `costMethodId` is `hourly` or `fixed_hourly`.
    - `overheadCostPerMonth` number, nullable: The overhead cost per month. `null` when `costMethodId` is `hourly` or `fixed_hourly`.
    - `totalCostPerMonth` number, nullable: The sum of `costPerMonth` and `overheadCostPerMonth`. `null` when `costMethodId` is `hourly` or `fixed_hourly`.
    - `createdAt` string, date-time: The timestamp when the object was created.
  - `hasMore` boolean: Whether there are more results available after this page.

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/ruddr/apis/ruddr-api.md) · [All operations](https://skmtc.dev/ruddr/apis/ruddr-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ruddr/apis/ruddr-api/revisions/01c3f2a969ba?raw)