FIfieldpulse
Projects

Retrieve projects list

List projects

get/projects

Request

  • Base URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage
  • URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/projects
  • Auth
    API key in header x-api-key

Query parameters

limitstring

Defaults to 20 items per page, maximum 100 items allowed.

sort_bystring

Allowed values: cuid, name,status_id,completion_percentage

sort_dirstring

Allowed values: asc, desc

pagestring

Page number. Starts from 1, defaults to 1.

searchstring

Search string.

calculate_countstring

true or false. If true, in response will be included also total count

filterstring

Array of attribute, operator, and value parts.

sortstring

Array of attribute and order values.

relstring

array consisting of indices with the desired relation to include

asnstring

Array or object containing either a team_id index, assigned_members index containing an array of member ids, or both.

Response

Successful response

errorboolean

false when the request succeeds.

total_countinteger

Total number of records that match the request, across all pages.

responseobject[]

Example response

{
  "total_count": 10
}

Changes

No recorded changes to this operation across all 2 revisions of this API.