CompanyCam

App · 20 actions

Manage project documentation, photos, project comments, people and tags.

Actions

ActionWhat it does
Archive projectArchive project in CompanyCam.
Create projectCreate project in CompanyCam.
Create project commentCreate project comment in CompanyCam.
Create tagCreate tag in CompanyCam.
Delete projectDelete project in CompanyCam.
Delete tagDelete tag in CompanyCam.
Get companyGet company in CompanyCam.
Get current userGet current user in CompanyCam.
Get photoGet photo in CompanyCam.
Get projectGet project in CompanyCam.
Get userGet user in CompanyCam.
List photosList photos in CompanyCam.
List project commentsList project comments in CompanyCam.
List project photosList project photos in CompanyCam.
List projectsList projects in CompanyCam.
List tagsList tags in CompanyCam.
List usersList users in CompanyCam.
Restore projectRestore project in CompanyCam.
Update projectUpdate project in CompanyCam.
Update tagUpdate tag in CompanyCam.

Archive project

Archive project in CompanyCam.

Inputs

Idproject_idnumberRequired
Id.
Bodybodyobject
Returned value.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "address": {
        "city": "example",
        "country": "example",
        "postal_code": "example",
        "state": "example",
        "street_address_1": "example",
        "street_address_2": "example"
      },
      "archived": false,
      "capture_photo_deeplink": "example",
      "company_id": "example",
      "coordinates": {
        "lat": 1,
        "lon": 1
      },
      "created_at": "example",
      "creator_id": "example",
      "creator_name": "example",
      "creator_type": "example",
      "customer_id": "example",
      "description": "example",
      "document_count": 1,
      "embedded_project_url": "example",
      "feature_image": [],
      "geofence": [],
      "id": "example",
      "name": "example",
      "photo_count": 1,
      "primary_contact": {
        "company_id": "example",
        "created_at": "example",
        "email": "example",
        "first_name": "example",
        "id": "example",
        "last_name": "example",
        "name": "example",
        "notes": "example",
        "phone_number": "example",
        "role": "example",
        "updated_at": "example"
      },
      "project_url": "example",
      "public": false,
      "public_url": "example",
      "slug": "example",
      "status": "example",
      "updated_at": "example"
    },
    "errors": [],
    "meta": {}
  }
}

Create project

Create project in CompanyCam.

Inputs

Project nameproject_nametextRequired
Returned value.
Project street address 1project_street_address_1textRequired
Returned value.
Project cityproject_citytextRequired
Returned value.
Project stateproject_statetextRequired
Returned value.
Project postal codeproject_postal_codetextRequired
Returned value.
Project countryproject_countrytextRequired
Returned value.
Project coordinatesproject_coordinatesobject
Returned value.
Project geofenceproject_geofencelist
Returned value.
Project primary contactproject_primary_contactobject
Returned value.
Project customer IDproject_customer_idtext
Returned value.
Project template IDproject_template_idtext
Returned value.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "address": {
        "city": "example",
        "country": "example",
        "postal_code": "example",
        "state": "example",
        "street_address_1": "example",
        "street_address_2": "example"
      },
      "archived": false,
      "capture_photo_deeplink": "example",
      "company_id": "example",
      "coordinates": {
        "lat": 1,
        "lon": 1
      },
      "created_at": "example",
      "creator_id": "example",
      "creator_name": "example",
      "creator_type": "example",
      "customer_id": "example",
      "description": "example",
      "document_count": 1,
      "embedded_project_url": "example",
      "feature_image": [],
      "geofence": [],
      "id": "example",
      "name": "example",
      "photo_count": 1,
      "primary_contact": {
        "company_id": "example",
        "created_at": "example",
        "email": "example",
        "first_name": "example",
        "id": "example",
        "last_name": "example",
        "name": "example",
        "notes": "example",
        "phone_number": "example",
        "role": "example",
        "updated_at": "example"
      },
      "project_url": "example",
      "public": false,
      "public_url": "example",
      "slug": "example",
      "status": "example",
      "updated_at": "example"
    },
    "errors": [],
    "meta": {}
  }
}

Create project comment

Create project comment in CompanyCam.

Inputs

Projectproject_idnumberRequired
Project ID.
Comment contentcomment_contenttextRequired
Returned value.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "commentable_id": "example",
      "commentable_type": "example",
      "content": "example",
      "created_at": "example",
      "creator_id": "example",
      "creator_name": "example",
      "creator_type": "example",
      "id": "example",
      "status": "example",
      "updated_at": "example"
    },
    "errors": [],
    "meta": {}
  }
}

Create tag

Create tag in CompanyCam.

Inputs

Tag display valuetag_display_valuetextRequired
Returned value.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "company_id": "example",
      "created_at": "example",
      "display_value": "example",
      "id": "example",
      "tag_type": "example",
      "updated_at": "example",
      "value": "example"
    },
    "errors": [],
    "meta": {}
  }
}

Delete project

Delete project in CompanyCam.

Inputs

Idproject_idnumberRequired
Id.

Outputs

dataobject
Returned value.
Example output
{
  "data": {}
}

Delete tag

Delete tag in CompanyCam.

Inputs

Idtag_idnumberRequired
Id.

Outputs

dataobject
Returned value.
Example output
{
  "data": {}
}

Get company

Get company in CompanyCam.

Inputs

None.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "address": {
        "city": "example",
        "country": "example",
        "postal_code": "example",
        "state": "example",
        "street_address_1": "example",
        "street_address_2": "example"
      },
      "id": "example",
      "logo": [],
      "name": "example",
      "status": "example"
    },
    "errors": [],
    "meta": {}
  }
}

Get current user

Get current user in CompanyCam.

Inputs

None.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "company_id": "example",
      "created_at": "example",
      "email_address": "example",
      "first_name": "example",
      "id": "example",
      "last_name": "example",
      "phone_number": "example",
      "profile_image": [],
      "status": "example",
      "updated_at": "example",
      "user_role": "example",
      "user_url": "example"
    },
    "errors": [],
    "meta": {}
  }
}

Get photo

Get photo in CompanyCam.

Inputs

Idphoto_idnumberRequired
Id.
Includeincludetext
Include.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "annotations": {
        "shapes": [],
        "stickers": [],
        "text": []
      },
      "captured_at": "example",
      "comment_count": 1,
      "comments": [],
      "company_id": "example",
      "coordinates": {
        "lat": 1,
        "lon": 1
      },
      "created_at": "example",
      "creator_id": "example",
      "creator_name": "example",
      "creator_type": "example",
      "description": {
        "html_content": "example",
        "id": "example",
        "plain_text_content": "example"
      },
      "has_comments": false,
      "hash": "example",
      "id": "example",
      "internal": false,
      "origin": "example",
      "photo_url": "example",
      "processing_status": "example",
      "project_id": "example",
      "status": "example",
      "tags": [],
      "updated_at": "example",
      "uris": []
    },
    "errors": [],
    "meta": {}
  }
}

Get project

Get project in CompanyCam.

Inputs

Idproject_idnumberRequired
Id.
Includeincludetext
Include.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "address": {
        "city": "example",
        "country": "example",
        "postal_code": "example",
        "state": "example",
        "street_address_1": "example",
        "street_address_2": "example"
      },
      "archived": false,
      "capture_photo_deeplink": "example",
      "comments": [],
      "company_id": "example",
      "coordinates": {
        "lat": 1,
        "lon": 1
      },
      "created_at": "example",
      "creator_id": "example",
      "creator_name": "example",
      "creator_type": "example",
      "custom_fields": [],
      "customer_id": "example",
      "description": "example",
      "document_count": 1,
      "embedded_project_url": "example",
      "feature_image": [],
      "geofence": [],
      "id": "example",
      "labels": [],
      "name": "example",
      "photo_count": 1,
      "primary_contact": {
        "company_id": "example",
        "created_at": "example",
        "email": "example",
        "first_name": "example",
        "id": "example",
        "last_name": "example",
        "name": "example",
        "notes": "example",
        "phone_number": "example",
        "role": "example",
        "updated_at": "example"
      },
      "project_url": "example",
      "public": false,
      "public_url": "example",
      "slug": "example",
      "status": "example",
      "updated_at": "example"
    },
    "errors": [],
    "meta": {}
  }
}

Get user

Get user in CompanyCam.

Inputs

Idmember_idnumberRequired
Id.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "company_id": "example",
      "created_at": "example",
      "email_address": "example",
      "first_name": "example",
      "id": "example",
      "last_name": "example",
      "phone_number": "example",
      "profile_image": [],
      "status": "example",
      "updated_at": "example",
      "user_role": "example",
      "user_url": "example"
    },
    "errors": [],
    "meta": {}
  }
}

List photos

List photos in CompanyCam.

Inputs

Afteraftertext
After.
Beforebeforetext
Before.
End dateend_datetext
End date.
Group IDsgroup_idslist
Group IDs.
Includeincludetext
Include.
Include totalinclude_totaltext
Include total.
Limitlimitnumber
Maximum number of records per page. Defaults to 50; values above 100 are clamped to 100.From 1 to 100.
Project IDsproject_idslist
Project IDs.
Start datestart_dateobject
See the documented object structure in the API reference.
Tag IDstag_idslist
Tag IDs.
User IDsuser_idslist
User IDs.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "errors": [],
    "meta": {
      "has_next": false,
      "has_prev": false,
      "next_cursor": "example",
      "prev_cursor": "example",
      "total": 1
    }
  }
}

List project comments

List project comments in CompanyCam.

Inputs

Projectproject_idnumberRequired
Project ID.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "errors": [],
    "meta": {
      "has_next": false,
      "has_prev": false,
      "next_cursor": "example",
      "prev_cursor": "example"
    }
  }
}

List project photos

List project photos in CompanyCam.

Inputs

Afteraftertext
After.
Beforebeforetext
Before.
End dateend_datetext
End date.
Group IDsgroup_idslist
Group IDs.
Limitlimitnumber
Maximum number of records per page. Defaults to 50; values above 100 are clamped to 100.From 1 to 100.
Projectproject_idnumberRequired
Project ID.
Start datestart_dateobject
See the documented object structure in the API reference.
Tag IDstag_idslist
Tag IDs.
User IDsuser_idslist
User IDs.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "errors": [],
    "meta": {
      "has_next": false,
      "has_prev": false,
      "next_cursor": "example",
      "prev_cursor": "example"
    }
  }
}

List projects

List projects in CompanyCam.

Inputs

Afteraftertext
After.
Archivedarchivedtext
Archived.
Ascasctext
Asc.
Assigned user IDsassigned_user_idslist
Assigned user IDs.
Beforebeforetext
Before.
Customer IDcustomer_idnumber
Customer ID.
Includeincludetext
Include.
Include totalinclude_totaltext
Include total.
Limitlimitnumber
Maximum number of records per page. Defaults to 50; values above 100 are clamped to 100.From 1 to 100.
Sort bysort_bytext
Sort by.
Statusstatustext
Status.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "errors": [],
    "meta": {
      "has_next": false,
      "has_prev": false,
      "next_cursor": "example",
      "prev_cursor": "example",
      "total": 1
    }
  }
}

List tags

List tags in CompanyCam.

Inputs

Limitlimitnumber
Maximum number of records per page. Defaults to 50; values above 100 are clamped to 100.From 1 to 100.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "errors": [],
    "meta": {
      "has_next": false,
      "has_prev": false,
      "next_cursor": "example",
      "prev_cursor": "example"
    }
  }
}

List users

List users in CompanyCam.

Inputs

Afteraftertext
After.
Limitlimitnumber
Maximum number of records per page. Defaults to 50; values above 100 are clamped to 100.From 1 to 100.
Statusstatustext
Narrows the list. `invited` returns users with a pending invitation and is limited to managers and admins. `active` returns accepted, non-deactivated users. Omit it for the default list of accepted users, including deactivated ones.One of: active, invited.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "errors": [],
    "meta": {
      "has_next": false,
      "has_prev": false,
      "next_cursor": "example",
      "prev_cursor": "example"
    }
  }
}

Restore project

Restore project in CompanyCam.

Inputs

Idproject_idnumberRequired
Id.
Bodybodyobject
Returned value.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "address": {
        "city": "example",
        "country": "example",
        "postal_code": "example",
        "state": "example",
        "street_address_1": "example",
        "street_address_2": "example"
      },
      "archived": false,
      "capture_photo_deeplink": "example",
      "company_id": "example",
      "coordinates": {
        "lat": 1,
        "lon": 1
      },
      "created_at": "example",
      "creator_id": "example",
      "creator_name": "example",
      "creator_type": "example",
      "customer_id": "example",
      "description": "example",
      "document_count": 1,
      "embedded_project_url": "example",
      "feature_image": [],
      "geofence": [],
      "id": "example",
      "name": "example",
      "photo_count": 1,
      "primary_contact": {
        "company_id": "example",
        "created_at": "example",
        "email": "example",
        "first_name": "example",
        "id": "example",
        "last_name": "example",
        "name": "example",
        "notes": "example",
        "phone_number": "example",
        "role": "example",
        "updated_at": "example"
      },
      "project_url": "example",
      "public": false,
      "public_url": "example",
      "slug": "example",
      "status": "example",
      "updated_at": "example"
    },
    "errors": [],
    "meta": {}
  }
}

Update project

Update project in CompanyCam.

Inputs

Idproject_idnumberRequired
Id.
Project nameproject_nametext
Returned value.
Project street address 1project_street_address_1text
Returned value.
Project cityproject_citytext
Returned value.
Project stateproject_statetext
Returned value.
Project primary contactproject_primary_contactobject
Returned value.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "address": {
        "city": "example",
        "country": "example",
        "postal_code": "example",
        "state": "example",
        "street_address_1": "example",
        "street_address_2": "example"
      },
      "archived": false,
      "capture_photo_deeplink": "example",
      "company_id": "example",
      "coordinates": {
        "lat": 1,
        "lon": 1
      },
      "created_at": "example",
      "creator_id": "example",
      "creator_name": "example",
      "creator_type": "example",
      "customer_id": "example",
      "description": "example",
      "document_count": 1,
      "embedded_project_url": "example",
      "feature_image": [],
      "geofence": [],
      "id": "example",
      "name": "example",
      "photo_count": 1,
      "primary_contact": {
        "company_id": "example",
        "created_at": "example",
        "email": "example",
        "first_name": "example",
        "id": "example",
        "last_name": "example",
        "name": "example",
        "notes": "example",
        "phone_number": "example",
        "role": "example",
        "updated_at": "example"
      },
      "project_url": "example",
      "public": false,
      "public_url": "example",
      "slug": "example",
      "status": "example",
      "updated_at": "example"
    },
    "errors": [],
    "meta": {}
  }
}

Update tag

Update tag in CompanyCam.

Inputs

Idtag_idnumberRequired
Id.
Tag display valuetag_display_valuetextRequired
Returned value.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "company_id": "example",
      "created_at": "example",
      "display_value": "example",
      "id": "example",
      "tag_type": "example",
      "updated_at": "example",
      "value": "example"
    },
    "errors": [],
    "meta": {}
  }
}

On this page