v1

latestOpenAPI 3.1.02026-07-2466150275.0 KB

Projects

Search Projects

Search for sites that match the provided search terms.

Keywords are searched for in the project name, project address and project city fields, along with all user defined fields (udf1, udf2 and udf3).

Additional explicit filters are also supported

get/v1/project/

Query parameters

querystring nullable

skipinteger nullable

limitinteger nullable

sort_direction'asc' | 'desc'

Direction to sort the sort_column - ascending or descending.

date_startstring date-time nullable

date_cut_offstring date-time nullable

sort_column'updated_at' | 'created_at' | 'id'

Which column to sort on

external_idsstring nullable

is_archivedboolean nullable

citystring nullable

countrystring nullable

is_privateboolean nullable

prime_idinteger nullable

user_idinteger nullable

Response

Successful Response

errorboolean

A boolean error indicator.

messagestring nullable

Optional message.

Example response

{
  "data": [
    {
      "id": 123,
      "name": "The Project Name",
      "address": "123 Somewhere Ave",
      "city": "Vancouver",
      "country": "Canada",
      "timezone": "America/Vancouver",
      "phone": "16045551234",
      "siteCode": 54231,
      "isPrivate": true,
      "primeId": 123,
      "companyProject": {
        "externalId": "100123",
        "externalSystemName": "Procore",
        "udf1": "Canada Division",
        "udf2": "BC Division",
        "udf3": "Eli's team"
      }
    }
  ]
}