v1

latestOpenAPI 3.0.02026-07-24622596.0 KB

Projects

List Projects

get/projects

Query parameters

pageinteger

per_pageinteger

querystring

An optional value to filter the projects by name or address line 1

modified_sincestring

An ISO8601 formatted date and time to return projects modified on or after the provided value

Response

List of projects sorted by most recent activity first

idstring required

A unique identifier for the Project.

company_idstring

A unique identifier for the Company the Project belongs to

creator_idstring

The id of the entity that created the Project

creator_typestring

The type of the entity that created the Project

creator_namestring

The display name of the entity that created the Project

status'active' | 'deleted'

Indicates the status of the Project.

archivedboolean

Indicates whether the Project is archived

namestring nullable

The title of the Project

project_urlstring

The URL to the Project in the web app

embedded_project_urlstring

The URL to an embeddable photo feed for the Project

slugstring

A unique identifier use the Project that is used to construct some public URLs

publicboolean

Indicates whether the Project’s timeline and other public features are enabled

notepadstring

Notes or description of the project

created_atinteger

Timestamp when the Project was created

updated_atinteger

Timestamp when the Project was updated

Example response

[
  {
    "id": "94772883",
    "company_id": "8292212",
    "creator_id": "2789583992",
    "creator_type": "User",
    "creator_name": "Shawn Spencer",
    "status": "active",
    "name": "Psych Office",
    "address": {
      "street_address_1": "808 P St",
      "city": "Lincoln",
      "state": "NE",
      "postal_code": "68508",
      "country": "US"
    },
    "coordinates": {
      "lat": 28.425852468018288,
      "lon": -81.47155671113255
    },
    "featured_image": [
      {
        "type": "original",
        "url": "https://static.companycam.com/VuS0rPvrnNA1490797262.jpg"
      },
      {
        "type": "web",
        "url": "https://static.companycam.com/VuS0rPvrnNA1490797262web.jpg"
      },
      {
        "type": "thumbnail",
        "url": "https://static.companycam.com/VuS0rPvrnNA1490797262small.jpg"
      }
    ],
    "project_url": "https://app.companycam.com/projects/1234",
    "embedded_project_url": "https://app.companycam.com/embed/projects/QrL2XjgF8P2dN6MPDRdV2Q",
    "integrations": [
      {
        "type": "JobNimbus",
        "relation_id": "123"
      }
    ],
    "slug": "QrL2XjgF8P2dN6MPDRdV2Q",
    "geofence": [
      {
        "lat": 28.425852468018288,
        "lon": -81.47155671113255
      }
    ],
    "primary_contact": {
      "id": "115",
      "project_id": "48892885",
      "name": "Joe Smith",
      "email": "joe.smith@companycam.com",
      "phone_number": "402-555-1212",
      "created_at": 1621857746,
      "updated_at": 1621857746
    },
    "notepad": "Be sure to let the client know when the work is finished",
    "created_at": 1152230400,
    "updated_at": 1395792000
  }
]