Skip to content

Fetching a list of Project Templates

Request

This endpoint returns structured Project Template 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 project_templates top-level JSON key. Please see our Response Format section for more information.

Query
by_titlestring

Only includes project templates where the title matches the specified search.

includestring

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

  • project_template_additional_tabs (ProjectTemplateAdditionalTab) - Retrieves the additional tabs added to the template. The response will include project_template_additional_tab_ids, which references the data in the project_template_additional_tabs top-level key.
  • project_template_assignments (ProjectTemplateAssignment) - Project template assignments associated with the project template.
  • user (User) - The user who created the project template (referenced by user_id).
matchingstring

Alias of by_title.

mineboolean

Only includes project templates created by the requesting user.

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.

optional_fieldsArray of strings

Allows you to request one or more optional fields as an array.

Items Value:"raw_json"
orderstring

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

Valid values: budget:asc, budget:desc, description:asc, description:desc, duration:asc, duration:desc, full_name:asc, full_name:desc, is_budgeted:asc, is_budgeted:desc, title:asc, title:desc, updated_at:asc, and updated_at:desc.

Default:"updated_at:desc"
pageinteger, (int32)
Default:1
per_pageinteger, (int32), <= 200
Default:20
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/project_templates?by_title=string&include=string&matching=string&mine=true&only=string&optional_fields=raw_json&order=updated_at%3Adesc&page=1&per_page=20'

Responses

A list of Project Templates have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
project_templatesobject
usersobject
project_template_assignmentsobject
project_template_additional_tabsobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "project_templates": {
    "property1": {
      "budget": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "currency": "string",
      "description": "string",
      "duration": 0,
      "is_budgeted": true,
      "item_count": 0,
      "permissions": {
        "can_edit_project_template": true
      },
      "project_template_additional_tab_ids": [
        "string"
      ],
      "project_template_assignment_ids": [
        "string"
      ],
      "raw_json": "string",
      "shared": true,
      "sharing": "string",
      "title": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string"
    },
    "property2": {
      "budget": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "currency": "string",
      "description": "string",
      "duration": 0,
      "is_budgeted": true,
      "item_count": 0,
      "permissions": {
        "can_edit_project_template": true
      },
      "project_template_additional_tab_ids": [
        "string"
      ],
      "project_template_assignment_ids": [
        "string"
      ],
      "raw_json": "string",
      "shared": true,
      "sharing": "string",
      "title": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_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"
      ]
    }
  },
  "project_template_assignments": {
    "property1": {
      "name": "string",
      "project_template_id": "string",
      "role_id": "string",
      "role_initials": "string",
      "role_name": "string",
      "total_count": 0,
      "total_estimated_minutes": 0
    },
    "property2": {
      "name": "string",
      "project_template_id": "string",
      "role_id": "string",
      "role_initials": "string",
      "role_name": "string",
      "total_count": 0,
      "total_estimated_minutes": 0
    }
  },
  "project_template_additional_tabs": {
    "property1": {
      "associated_tab_id": 0,
      "project_template_id": 0,
      "tab_type": "string"
    },
    "property2": {
      "associated_tab_id": 0,
      "project_template_id": 0,
      "tab_type": "string"
    }
  }
}