---
title: "GET /api/projects"
method: GET
path: "/api/projects"
tags: ["api"]
---

# GET /api/projects

`GET /api/projects`

## Query parameters

- `page` integer
- `page_size` integer
- `search` string
- `ordering` string

## Response `200`

OK

- object
  - `count` integer, required
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `results` Project[], required
    - `pid` string, uuid — A UUID identifying this project.
    - `name` string, required — Project's name.
    - `category` 'NOT SPECIFIED' | 'E-COMMERCE' | 'LOGISTICS' | 'FINANCE' | 'EDUCATIONAL' | 'TECHNOLOGY' | 'OTHER_CATEGORY' — Project's category.
    - `framework` 'SCRAPY' | 'REQUESTS' — Project's framework.
    - `container_image` string — Path of the project's container image.
    - `users` Permission[] — Users with permissions on this project.
      - `user` UserDetail — User details.
        - `username` string, required — Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
        - `email` string, email
      - `permission` 'OWNER' | 'ADMIN' | 'DEVELOPER' | 'VIEWER' — Permission on this project.
    - `env_vars` SpiderJobEnvVar[] — Project env variables.
      - `evid` integer, nullable — A unique integer value identifying this job env variable.
      - `name` string, required — Env variable name.
      - `value` string, required — Env variable value.
      - `masked` boolean — Whether the env variable value is masked.
    - `data_status` 'PERSISTENT' | 'PENDING' — Data status.
    - `data_expiry_days` integer — Days before data is deleted.
    - `created` string
    - `last_modified` string

---

[API](https://skmtc.net/bitmakerla/apis/estela-api-v1-0-documentation.md) · [All operations](https://skmtc.net/bitmakerla/apis/estela-api-v1-0-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bitmakerla/estela-api-v1-0-documentation/revisions/ec53774a2b78/schema)