v1

latestOpenAPI 3.0.02026-07-24622596.0 KB

Checklists

List All Checklists

get/checklists

Query parameters

pageinteger

per_pageinteger

completedboolean

Response

List of checklists sorted by last updated

idstring

The unique ID for the Checklist

company_idstring

A unique identifier for the Company the Checklist belongs to

project_idstring

A unique identifier for the Project the Checklist belongs to

namestring

The name for the Checklist

created_atinteger

Timestamp when the Checklist was created on the server.

updated_atinteger

Timestamp when the Checklist was last updated

completed_atinteger nullable

Timestamp when the Checklist was completed

creator_idstring

A unique identifier for the creator of the Checklist

checklist_template_idstring nullable

A unique identifier for the template used to create the Checklist

is_populatingboolean

Flag indicating wether the Checklist is still being created or not

Example response

[
  {
    "id": "4782987471",
    "company_id": "8292212",
    "project_id": "812",
    "name": "Roof state survey",
    "created_at": 1152230608,
    "updated_at": 1152230400,
    "completed_at": 1232230400,
    "creator_id": "314",
    "checklist_template_id": "4156",
    "sectionless_tasks": [
      {
        "id": "4782987471",
        "completed_at": 1152230608,
        "completed_by_id": "14365",
        "completed_by_type": "User",
        "created_at": 1152230608,
        "creator_id": "314",
        "creator_type": "User",
        "details": "Check the roof for leaks",
        "photo_capture_required": true,
        "position": 2,
        "todo_list_id": "4782987471",
        "todo_list_section_id": "12663",
        "title": "Check the roof",
        "updated_at": 1152230608,
        "sub_tasks": [
          {
            "id": "4782987471",
            "label": "Check the roof",
            "answer_type": "open_text",
            "answer_choices": [
              0,
              2
            ],
            "position": 2,
            "task_id": "4782987471",
            "answer_text": "It was a pretty ok task"
          }
        ],
        "photos": [
          {
            "id": "4782987471",
            "company_id": "8292212",
            "creator_id": "2789583992",
            "creator_type": "User",
            "creator_name": "Shawn Spencer",
            "project_id": "94772883",
            "processing_status": "processed",
            "status": "active",
            "coordinates": {
              "lat": 28.425852468018288,
              "lon": -81.47155671113255
            },
            "uris": [
              {
                "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"
              }
            ],
            "hash": "00ab337b7399151e5d4aa3bd4226e8dd",
            "description": "The front of the house",
            "photo_url": "https://app.companycam.com/photos/8675309",
            "captured_at": 1152230396,
            "created_at": 1152230608,
            "updated_at": 1152230400
          }
        ]
      }
    ],
    "sections": [
      {
        "id": "4782987471",
        "todo_list_id": "8292212",
        "creator_id": "314",
        "creator_type": "User",
        "creator_name": "314",
        "title": "Section #1",
        "tasks": [
          {
            "id": "4782987471",
            "completed_at": 1152230608,
            "completed_by_id": "14365",
            "completed_by_type": "User",
            "created_at": 1152230608,
            "creator_id": "314",
            "creator_type": "User",
            "details": "Check the roof for leaks",
            "photo_capture_required": true,
            "position": 2,
            "todo_list_id": "4782987471",
            "todo_list_section_id": "12663",
            "title": "Check the roof",
            "updated_at": 1152230608,
            "sub_tasks": [
              {
                "id": "4782987471",
                "label": "Check the roof",
                "answer_type": "open_text",
                "answer_choices": [
                  0,
                  2
                ],
                "position": 2,
                "task_id": "4782987471",
                "answer_text": "It was a pretty ok task"
              }
            ],
            "photos": [
              {
                "id": "4782987471",
                "company_id": "8292212",
                "creator_id": "2789583992",
                "creator_type": "User",
                "creator_name": "Shawn Spencer",
                "project_id": "94772883",
                "processing_status": "processed",
                "status": "active",
                "coordinates": {
                  "lat": 28.425852468018288,
                  "lon": -81.47155671113255
                },
                "uris": [
                  {
                    "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"
                  }
                ],
                "hash": "00ab337b7399151e5d4aa3bd4226e8dd",
                "description": "The front of the house",
                "photo_url": "https://app.companycam.com/photos/8675309",
                "captured_at": 1152230396,
                "created_at": 1152230608,
                "updated_at": 1152230400
              }
            ]
          }
        ]
      }
    ]
  }
]

All 62 operations