Skip to content

Fetching a list of Workweek Memberships

Request

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 for more information.

Query
created_afterstring, (date-time)

Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.

created_beforestring, (date-time)

Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.

effective_datestring, (date)

Includes only workweek memberships with a start date before, and an end date after, the specified date. The date must be in ISO 8601 format.

includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • user (User) - References the user to whom the workweek membership belongs.
  • workweek (Workweek) - References the associated workweek.
onlystring

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

orderstring

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: start_date:asc and start_date:desc.

Default:"start_date:asc"
pageinteger, (int32)
Default:1
participants_for_workspace_idinteger, (int32)

Limit Workweek Memberships by those participating in the workspace of the specified workspace ID.

participating_withboolean

Limits workweek memberships to those associated with the user making the request.

per_pageinteger, (int32), <= 200
Default:20
updated_afterstring, (date-time)

Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.

updated_beforestring, (date-time)

Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.

user_idsArray of integers, (int32)

Includes only workweek memberships that belong to the specified user IDs.

GET
/workweek_memberships
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/workweek_memberships?created_after=2019-08-24T14%3A15%3A22Z&created_before=2019-08-24T14%3A15%3A22Z&effective_date=2019-08-24&include=string&only=string&order=start_date%3Aasc&page=1&participants_for_workspace_id=0&participating_with=true&per_page=20&updated_after=2019-08-24T14%3A15%3A22Z&updated_before=2019-08-24T14%3A15%3A22Z&user_ids=0'

Responses

A list of Workweek Memberships have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
workweek_membershipsobject
usersobject
workweeksobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "workweek_memberships": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "end_date": "2019-08-24",
      "start_date": "2019-08-24",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": 0,
      "workweek_id": "string"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "end_date": "2019-08-24",
      "start_date": "2019-08-24",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": 0,
      "workweek_id": "string"
    }
  },
  "users": {
    "property1": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    },
    "property2": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    }
  },
  "workweeks": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "default": true,
      "end_date": "2019-08-24",
      "friday_minutes": 0,
      "monday_minutes": 0,
      "saturday_minutes": 0,
      "start_date": "2019-08-24",
      "sunday_minutes": 0,
      "thursday_minutes": 0,
      "total_minutes": 0,
      "tuesday_minutes": 0,
      "updated_at": "2019-08-24T14:15:22Z",
      "wednesday_minutes": 0,
      "workweek_membership_ids": [
        "string"
      ]
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "default": true,
      "end_date": "2019-08-24",
      "friday_minutes": 0,
      "monday_minutes": 0,
      "saturday_minutes": 0,
      "start_date": "2019-08-24",
      "sunday_minutes": 0,
      "thursday_minutes": 0,
      "total_minutes": 0,
      "tuesday_minutes": 0,
      "updated_at": "2019-08-24T14:15:22Z",
      "wednesday_minutes": 0,
      "workweek_membership_ids": [
        "string"
      ]
    }
  }
}