---
title: "Fetching a list of Workweek Memberships"
method: GET
path: "/workweek_memberships"
tags: ["Workweek Memberships"]
---

# Fetching a list of Workweek Memberships

`GET /workweek_memberships`

## Request

- Base URL: `https://api.mavenlink.com/api/v1`
- URL: `https://api.mavenlink.com/api/v1/workweek_memberships`
- Auth: none declared

The Workweek Memberships endpoint provides a list of all workweek memberships that belongs to the
account of the user making the request. The response will contain an array of workweek membership
objects, sorted by their `start_date`.


This endpoint returns structured Workweek Membership objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array
and will be indexed by ID in the `workweek_memberships` top-level JSON key.
Please see our [Response Format](#section/Response-Format) section for more information.

## Query parameters

- `created_after` string, date-time
- `created_before` string, date-time
- `effective_date` string, date
- `include` string
- `only` string
- `order` string
- `page` integer
- `participants_for_workspace_id` integer
- `participating_with` boolean
- `per_page` integer
- `updated_after` string, date-time
- `updated_before` string, date-time
- `user_ids` integer[]

## Response `200`

A list of Workweek Memberships have been retrieved.

- object
  - `count` integer
  - `meta` object
    - `count` integer
    - `page_count` integer
    - `page_number` integer
    - `page_size` integer
  - `results` object[]
    - `key` string
    - `id` string
  - `workweek_memberships` object
  - `users` object
  - `workweeks` object

## Other responses

- `400`: Bad Request
- `401`: Unauthorized request
- `403`: Forbidden request
- `404`: Page Not Found
- `422`: Unprocessable Entity
- `503`: Service is unavailable

---

[API](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation.md) - [All operations](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation/revisions/9d4ebed2fa98?raw)
