GET/projects/api/v3/projects/teamwork/samples.json

Returns a list of teamwork sample projects

Retrieve all sample projects for the provided filters.

Query Params

  • Name
    searchTerm
    Type
    string
    Description

    filter by project name

  • Name
    pageSize
    Type
    integer
    Description

    number of items in a page (not used when generating reports)

    Default
    50
  • Name
    page
    Type
    integer
    Description

    page number (not used when generating reports)

    Default
    1
  • Name
    skipCounts
    Type
    boolean
    Description

    SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.

  • Name
    ids
    Type
    array[integer]
    Description

    filter by sample ids

    Format
    Comma separated values
  • Name
    fields[sampleprojects]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • code
    • description
    • icon
    • imagePreview
    • categoryId
    • content
  • Name
    categoryIds
    Type
    array[integer]
    Description

    filter by category ids

    Format
    Comma separated values

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    SampleProjectsResponse contains information about a group of sample projects.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.
  • Code
    403
    Type
    object
    Schema
    Description
    403 Forbidden
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

SampleProjectsResponse
{
  "included": {
    "projectCategories": {
      "additionalProp": {
        "color": "string",
        "count": 0,
        "id": 0,
        "name": "string",
        "parent": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "parentId": 0
      }
    }
  },
  "meta": {
    "averageSpend": 0,
    "limit": 0,
    "nextCursor": "string",
    "page": {
      "count": 0,
      "hasMore": true,
      "pageOffset": 0,
      "pageSize": 0
    },
    "prevCursor": "string",
    "totalCapacity": 0
  },
  "projects": [
    {
      "categoryId": 0,
      "code": "string",
      "description": "string",
      "icon": "string",
      "id": 0,
      "imagePreview": "string",
      "name": "string"
    }
  ]
}
Download Swagger