---
updatedAt: 2026-05-27T06:01:58.000Z
agentTools:
  projectIndex: https://developers.botify.com/llms.txt
---

# /projects/{username}

List all active projects for the user

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "description": "Botify Saas API",
    "title": "Botify API"
  },
  "paths": {
    "/projects/{username}": {
      "get": {
        "description": "List all active projects for the user",
        "summary": "",
        "operationId": "getUserProjects",
        "tags": [
          "User"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "name",
            "description": "Project's name",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "page",
            "description": "Page Number",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 1
            }
          },
          {
            "in": "query",
            "name": "size",
            "description": "Page Size",
            "required": false,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "next": {
                      "type": "string"
                    },
                    "previous": {
                      "type": "string"
                    },
                    "count": {
                      "type": "integer"
                    },
                    "results": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Project"
                      }
                    },
                    "page": {
                      "type": "integer"
                    },
                    "size": {
                      "type": "integer"
                    }
                  }
                }
              }
            }
          },
          "default": {
            "description": "error payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DefaultPayload"
                }
              }
            }
          }
        }
      },
      "parameters": [
        {
          "name": "username",
          "in": "path",
          "required": true,
          "description": "User's identifier",
          "schema": {
            "type": "string"
          }
        }
      ]
    }
  },
  "security": [
    {
      "DjangoRestToken": []
    }
  ],
  "servers": [
    {
      "url": "https://api.botify.com/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "DjangoRestToken": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    },
    "schemas": {
      "Project": {
        "properties": {
          "name": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "user": {
            "$ref": "#/components/schemas/User"
          },
          "organization": {
            "$ref": "#/components/schemas/OrganizationUser"
          },
          "current_settings": {
            "$ref": "#/components/schemas/ProjectSettings"
          },
          "active": {
            "type": "boolean"
          },
          "date_created": {
            "type": "string",
            "readOnly": true
          },
          "url": {
            "type": "string",
            "readOnly": true
          },
          "last_analysis": {
            "type": "object",
            "readOnly": true
          },
          "timezone": {
            "type": "string"
          },
          "auto_pin_first_analysis": {
            "type": "boolean"
          },
          "settings_url": {
            "type": "string",
            "readOnly": true
          },
          "retention_period": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "maximum": 2147483647
          },
          "public_id": {
            "type": "string",
            "readOnly": true
          },
          "account_id": {
            "type": "string",
            "readOnly": true
          },
          "pk": {
            "type": "string",
            "readOnly": true
          },
          "has_crawl": {
            "type": "boolean"
          },
          "has_logs": {
            "type": "boolean"
          },
          "has_keywords": {
            "type": "string",
            "readOnly": true
          },
          "max_gsc_websites": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "maximum": 32767
          },
          "max_gsc_via_bq_websites": {
            "type": "integer",
            "format": "int64",
            "description": "Maximum number of GSC properties that can be activated using BigQuery bulk export",
            "minimum": 0,
            "maximum": 32767
          },
          "realkeywords_aggregation_type": {
            "type": "integer",
            "format": "int64",
            "description": "If 'New: By website & by URL' is selected, data will be shown aggregated by website wherever possible in RealKeywords"
          },
          "actionboard_enabled": {
            "type": "boolean"
          },
          "has_actionboard": {
            "type": "string",
            "readOnly": true
          },
          "has_alertpanel": {
            "type": "string",
            "readOnly": true
          },
          "has_engagement_analytics": {
            "type": "boolean"
          },
          "has_speedworkers": {
            "type": "string",
            "readOnly": true
          },
          "has_pageworkers": {
            "type": "string",
            "readOnly": true
          },
          "pulse_enabled": {
            "type": "boolean"
          },
          "has_pulse": {
            "type": "string",
            "readOnly": true
          },
          "has_smartcontent": {
            "type": "string",
            "readOnly": true
          },
          "has_smartlink": {
            "type": "string",
            "readOnly": true
          },
          "has_agentic_catalog": {
            "type": "string",
            "readOnly": true
          },
          "has_gen_ai": {
            "type": "boolean"
          },
          "has_ai_consent": {
            "type": "string",
            "readOnly": true
          },
          "has_web_vitals_field_data": {
            "type": "boolean"
          },
          "last_actionboard_revision": {
            "type": "string",
            "readOnly": true
          },
          "permissions": {
            "type": "string",
            "readOnly": true
          },
          "tree_colors": {
            "type": "string",
            "readOnly": true
          },
          "activation_website_id": {
            "type": "string"
          },
          "pulse_website_id": {
            "type": "string"
          },
          "max_extracts": {
            "type": "integer",
            "format": "int64"
          },
          "category": {
            "type": "string",
            "default": 0
          },
          "webproperty": {
            "$ref": "#/components/schemas/WebProperty"
          },
          "main_segment": {
            "type": "string",
            "readOnly": true
          },
          "recurring_crawl_settings": {
            "$ref": "#/components/schemas/RecurringCrawlSettings"
          },
          "next_launch_date": {
            "type": "string",
            "readOnly": true
          },
          "private_config": {
            "type": "string",
            "readOnly": true
          },
          "has_page_qualification": {
            "type": "string",
            "readOnly": true
          },
          "employee_access": {
            "type": "string",
            "readOnly": true
          }
        },
        "type": "object",
        "required": [
          "name",
          "slug",
          "user",
          "organization",
          "current_settings",
          "has_crawl",
          "has_logs",
          "actionboard_enabled",
          "has_engagement_analytics",
          "pulse_enabled",
          "has_gen_ai",
          "has_web_vitals_field_data",
          "max_extracts",
          "webproperty",
          "recurring_crawl_settings"
        ]
      },
      "OrganizationUser": {
        "properties": {
          "owner": {
            "$ref": "#/components/schemas/User"
          },
          "name": {
            "type": "string",
            "readOnly": true
          },
          "slug": {
            "type": "string",
            "readOnly": true
          },
          "is_organization": {
            "type": "string",
            "readOnly": true
          },
          "email": {
            "type": "string",
            "readOnly": true
          }
        },
        "type": "object",
        "required": [
          "owner"
        ]
      },
      "User": {
        "properties": {
          "username": {
            "type": "string",
            "description": "Required. 30 characters or fewer. Letters, numbers and /-/_/. characters"
          },
          "first_name": {
            "type": "string"
          },
          "last_name": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "full_name": {
            "type": "string",
            "readOnly": true
          }
        },
        "type": "object",
        "required": [
          "username"
        ]
      },
      "WebProperty": {
        "properties": {
          "public_id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "domain": {
            "type": "string"
          },
          "current_subscription_plan": {
            "$ref": "#/components/schemas/SubscriptionPlan"
          },
          "renewal_subscription_plan": {
            "$ref": "#/components/schemas/SubscriptionPlan"
          }
        },
        "type": "object",
        "required": [
          "public_id",
          "name",
          "domain",
          "current_subscription_plan",
          "renewal_subscription_plan"
        ]
      },
      "SubscriptionPlan": {
        "properties": {
          "plan": {
            "type": "string"
          },
          "start_date": {
            "type": "string",
            "format": "date-time"
          },
          "data_retention": {
            "type": "string",
            "readOnly": true
          },
          "alert_panel": {
            "type": "string",
            "readOnly": true
          },
          "smart_activation": {
            "type": "string",
            "readOnly": true
          }
        },
        "type": "object",
        "required": [
          "plan",
          "start_date"
        ]
      },
      "ProjectSettings": {
        "properties": {
          "blacklisted_domains": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "allowed_domains": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "pk": {
            "type": "string",
            "readOnly": true
          }
        },
        "type": "object",
        "required": [
          "blacklisted_domains",
          "allowed_domains"
        ]
      },
      "RecurringCrawlSettings": {
        "properties": {
          "recurring_type": {
            "type": "string",
            "readOnly": true
          },
          "interval": {
            "type": "integer",
            "format": "int64",
            "description": "Every N days/weeks/months",
            "minimum": 0,
            "maximum": 2147483647
          },
          "time": {
            "type": "string"
          },
          "recurring_type_month": {
            "type": "string",
            "readOnly": true
          },
          "day_of_month": {
            "type": "string",
            "readOnly": true
          },
          "naive_time": {
            "type": "string"
          },
          "minute_delay": {
            "type": "integer",
            "format": "int64",
            "minimum": 60,
            "maximum": 10080
          }
        },
        "type": "object"
      },
      "DefaultPayload": {
        "type": "object",
        "description": "default payload for object for all HTTP codes that are not covered individually",
        "properties": {
          "error": {
            "type": "object",
            "properties": {
              "message": {
                "description": "Error Message",
                "type": "string"
              },
              "error_code": {
                "description": "Error Code",
                "type": "string"
              },
              "error_detail": {
                "description": "If available, detailed error",
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}
```