USusepylon
projects

Search for projects by a given filter

Changed on

Filterable fields and their allowed operators:

FieldAllowed operators
account_idequals, in, not_in, is_set
statusequals, in, not_in
owner_idequals, in, not_in, is_set, is_unset
is_archivedequals
created_attime_is_after, time_is_before, time_range
updated_attime_is_after, time_is_before, time_range

Timestamp values use RFC3339 format. Valid status values are not_started, in_progress, and completed. For custom fields, pass the field slug as field.

Rate limit: 120 requests per minute

post/projects/search

Request

  • Base URL
    https://api.usepylon.com
  • URL
    https://api.usepylon.com/projects/search
  • Auth
    HTTP bearer

Request body

cursorstring

The cursor to use for pagination.

limitinteger

The number of projects to fetch. Defaults to 100. Must be greater than 0 and less than 1000.

Example request

{
  "filter": {
    "subfilters": [
      {
        "field": "state",
        "operator": "equals",
        "value": "new"
      }
    ]
  }
}

Response

request_idstring required

Example response

{
  "data": [
    {
      "custom_fields": {
        "health": {
          "value": "on_track"
        }
      }
    }
  ]
}

Changes

  • 8522e66913b4Revision changes
    • info

      added the new not enum value to the request property /

    • info

      added the new time_is_in_last enum value to the request property /

    • info

      added the new time_is_in_next enum value to the request property /

    • info

      added the new time_is_not_in_last enum value to the request property /

    • info

      added the new time_is_not_in_next enum value to the request property /

  • 554844ef05a1Revision changes
    • info

      added the required property // to the response with the status