List Projects

Returns cloud-linked Projects for the current account.

Operation IDlistPlaybookProjects

get/v3/playbook/projects

Example requestcURL

curl -X GET 'https://api.sumr.co/v3/playbook/projects' \
  -H 'Authorization: Bearer <token>'

Query parameters

page

Page number.

number · min: 1 · max: 9007199254740991

pageSize

Number of items per page.

number · min: 1 · max: 100

Body

This endpoint does not require a JSON request body.

Responses

200Projects returned.

PaginatedPlaybookProjectsDto

{
  "properties": {
    "data": {
      "items": {
        "properties": {
          "archivedAt": {
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
            "type": "string"
          },
          "createdAt": {
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
            "type": "string"
          },
          "description": {
            "maxLength": 1000,
            "type": "string"
          },
          "id": {
            "format": "uuid",
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
            "type": "string"
          },
          "localProjectId": {
            "maxLength": 160,
            "type": "string"
          },
          "metadata": {
            "additionalProperties": {},
            "propertyNames": {
              "type": "string"
            },
            "type": "object"
          },
          "name": {
            "maxLength": 180,
            "minLength": 1,
            "type": "string"
          },
          "repoUrl": {
            "maxLength": 500,
            "type": "string"
          },
          "slug": {
            "maxLength": 120,
            "minLength": 1,
            "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
            "type": "string"
          },
          "status": {
            "enum": [
              "active",
              "archived"
            ],
            "type": "string"
          },
          "updatedAt": {
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
            "type": "string"
          }
        },
        "required": [
          "id",
          "slug",
          "name",
          "status",
          "createdAt",
          "updatedAt"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "meta": {
      "properties": {
        "page": {
          "maximum": 9007199254740991,
          "minimum": 1,
          "type": "integer"
        },
        "pageCount": {
          "maximum": 9007199254740991,
          "minimum": 0,
          "type": "integer"
        },
        "pageSize": {
          "maximum": 9007199254740991,
          "minimum": 1,
          "type": "integer"
        },
        "total": {
          "maximum": 9007199254740991,
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "page",
        "pageSize",
        "pageCount",
        "total"
      ],
      "type": "object"
    }
  },
  "required": [
    "data",
    "meta"
  ],
  "type": "object"
}