GET - List of check lists

List of check lists

Request

• Method: GET
• Endpoint: /check-lists
• Base URL: https://api.targpatrol.com/api/v1
• Operation ID: list-of-check-lists

Authorization

This endpoint requires an external API key.

x-api-key: {your_external_api_key}

Parameters

Name	In	Required	Schema	Description
limit	query	no	integer	include first N items of a resource collection
offset	query	no	number	exclude first N items of a resource collection
q	query	no	string	This parameter is used for quick search across text fields.
tags	query	no	string	filter by tags
actionId	query	no	string	filter by actionIds
actionType	query	no	string	filter by action value type

Responses

200 OK

Content-Type: application/json Schema: object

Schema

{
  "allOf": [
    {
      "$ref": "#/components/schemas/PageResponse"
    },
    {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CheckListResponse"
          }
        }
      }
    }
  ]
}

Example: example-1

{
  "data": [
    {
      "id": "2e04ee59-c0af-4621-adea-f854d4b8572b",
      "name": "Kitchen list 1",
      "actionIds": [
        "1cea9223-e7d4-4b12-becc-9482afd7999d",
        "ed13f992-7de6-4f0d-b77f-baa47ae00ec9"
      ],
      "tags": [
        "kitchen"
      ]
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 20,
    "count": 1000,
    "sort": [
      {
        "property": "id",
        "direction": "asc"
      }
    ]
  }
}

401 Unauthorized

500 Internal Server Error

Content-Type: application/json Schema: ErrorResponse

Schema

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Example: example-1

{
  "message": "internal server error",
  "code": "internal.server.error",
  "timestamp": "2023-03-07T05:57:59.315Z"
}