Skip to content

Workweeks

Workweeks in Kantata OX are owned by an Account. They can be used as the default for an Account or can be associated to a User through a Workweek Membership.

Operations

Fetching a list of Workweeks

Request

The Workweeks endpoint provides a list of every default Workweek that belongs to the Account of the User making the request. The response will contain an array of Workweek objects, sorted by their start_date.

This endpoint returns structured Workweek 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 workweeks 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 workweeks that are effective on and 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.

  • workweek_memberships (WorkweekMembership) - References the workweek memberships that use the 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: created_at:asc, created_at:desc, start_date:asc, and start_date:desc.

Default:"start_date:asc"
pageinteger, (int32)
Default:1
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.

GET
/workweeks
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/workweeks?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&per_page=20&updated_after=2019-08-24T14%3A15%3A22Z&updated_before=2019-08-24T14%3A15%3A22Z'

Responses

A list of Workweeks have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
workweeksobject
workweek_membershipsobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "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"
      ]
    }
  },
  "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"
    }
  }
}