> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://api-docs.botbye.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api-docs.botbye.com/_mcp/server. # find all GET {base_url}/api/v1/{account_id}/projects This endpoint makes an HTTP GET request to retrieve a list of projects associated with the specified account. The response is in JSON format and varies based on the available projects. #### Request No request body parameters are required for this endpoint. **Path Parameters:** - `account_id` (string): The unique identifier of the account. ##### Query Parameters: - see [Pagination query parameters](https://botbye.com/docs/api#query-parameters) The response schema for this request can be documented as follows: ``` json { "type": "object", "properties": { "edges": { "type": "array", "items": { "type": "object", "properties": { "cursor": { "type": "string" }, "node": { "type": "object", "properties": { "id": { "type": "string" }, "customerId": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "siteKey": { "type": "string" }, "serverKey": { "type": "string" }, "isProtected": { "type": "boolean" }, "rules": { "type": "object", "properties": { "order": { "type": "array" }, "rules": { "type": "array" } } }, "rateLimits": { "type": "object", "properties": { "order": { "type": "array" }, "rateLimits": { "type": "array" } } }, "phishingInfo": { "type": "object", "properties": { "originalUrl": { "type": "string" }, "action": { "type": "string" }, "allowedUrls": { "type": "array" } } }, "responseExtraFields": { "type": "array" }, "updatedAt": { "type": "string" }, "createdAt": { "type": "string" } } } } } }, "pageInfo": { "type": "object", "properties": { "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "startCursor": { "type": ["string", "null"] }, "endCursor": { "type": ["string", "null"] }, "total": { "type": "integer" } } }, "attributes": { "type": "object" } } } ``` Reference: https://api-docs.botbye.com/bot-bye-api/protection/projects/find-all ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: collection version: 1.0.0 paths: /api/v1/{account_id}/projects: get: operationId: find-all summary: find all description: >- This endpoint makes an HTTP GET request to retrieve a list of projects associated with the specified account. The response is in JSON format and varies based on the available projects. #### Request No request body parameters are required for this endpoint. **Path Parameters:** - `account_id` (string): The unique identifier of the account. ##### Query Parameters: - see [Pagination query parameters](https://botbye.com/docs/api#query-parameters) The response schema for this request can be documented as follows: ``` json { "type": "object", "properties": { "edges": { "type": "array", "items": { "type": "object", "properties": { "cursor": { "type": "string" }, "node": { "type": "object", "properties": { "id": { "type": "string" }, "customerId": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "siteKey": { "type": "string" }, "serverKey": { "type": "string" }, "isProtected": { "type": "boolean" }, "rules": { "type": "object", "properties": { "order": { "type": "array" }, "rules": { "type": "array" } } }, "rateLimits": { "type": "object", "properties": { "order": { "type": "array" }, "rateLimits": { "type": "array" } } }, "phishingInfo": { "type": "object", "properties": { "originalUrl": { "type": "string" }, "action": { "type": "string" }, "allowedUrls": { "type": "array" } } }, "responseExtraFields": { "type": "array" }, "updatedAt": { "type": "string" }, "createdAt": { "type": "string" } } } } } }, "pageInfo": { "type": "object", "properties": { "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "startCursor": { "type": ["string", "null"] }, "endCursor": { "type": ["string", "null"] }, "total": { "type": "integer" } } }, "attributes": { "type": "object" } } } ``` tags: - subpackage_projects parameters: - name: account_id in: path required: true schema: type: string - name: cursor in: query description: "(Optional): a cursor for pagination.\n\t - `after` (string): Pointer to the item after which the items are to be retrieved.\n\t - `before` (string): Pointer to the item before which the items are to be retrieved." required: false schema: type: string - name: where in: query description: "(Optional): is used to create conditions for data filtering. It can be used to create simple conditions (leaf nodes) as well as compound logical expressions (branch nodes).\n\t- `predicate` (string): The filtering condition (e.g., `gte`, `lte`, `eq` for a leaf or `and`, `or` for a branch). Possible values [[#Predicate]]\n\t- `opearands` (string): A list of nested conditions (used only for branches, such as `and`, `or`).\n\t- `fieldPath` (string): The field to which the filtering condition is applied (used only for a leaf. Each entity has its own fieldPath list).\n\t- `value` (string): The value to compare against the field (used only for a leaf)." required: false schema: type: string - name: order_by in: query description: "(Optional): property by which to order by.\n\t- `fieldPath` (string): name of order field.\n\t- `direction` (string): `ASC` or `DESC`" required: false schema: type: string - name: limit in: query description: >- (Optional): specifies the maximum number of results to return in a single response. By default - 20, max - 100. required: false schema: type: string responses: '200': description: success content: application/json: schema: $ref: '#/components/schemas/Projects_findAll_Response_200' '400': description: fail content: application/json: schema: type: array items: $ref: >- #/components/schemas/ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaItems servers: - url: '{base_url}' description: '{base_url}' components: schemas: ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaEdgesItemsNodeRules: type: object properties: order: type: array items: description: Any type rules: type: array items: description: Any type required: - order - rules title: >- ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaEdgesItemsNodeRules ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaEdgesItemsNodeRateLimits: type: object properties: order: type: array items: description: Any type rateLimits: type: array items: description: Any type required: - order - rateLimits title: >- ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaEdgesItemsNodeRateLimits ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaEdgesItemsNodePhishingInfo: type: object properties: originalUrl: type: string format: uri action: type: string allowedUrls: type: array items: description: Any type required: - originalUrl - action - allowedUrls title: >- ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaEdgesItemsNodePhishingInfo ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaEdgesItemsNode: type: object properties: id: type: string format: uuid customerId: type: string format: uuid name: type: string url: type: string format: uri siteKey: type: string format: uuid serverKey: type: string format: uuid isProtected: type: boolean rules: $ref: >- #/components/schemas/ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaEdgesItemsNodeRules rateLimits: $ref: >- #/components/schemas/ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaEdgesItemsNodeRateLimits phishingInfo: $ref: >- #/components/schemas/ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaEdgesItemsNodePhishingInfo responseExtraFields: type: array items: description: Any type updatedAt: type: string format: utc-millisec createdAt: type: string format: utc-millisec required: - id - customerId - name - url - siteKey - serverKey - isProtected - rules - rateLimits - phishingInfo - responseExtraFields - updatedAt - createdAt title: >- ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaEdgesItemsNode ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaEdgesItems: type: object properties: cursor: type: string node: $ref: >- #/components/schemas/ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaEdgesItemsNode required: - cursor - node title: ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaEdgesItems ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaPageInfo: type: object properties: hasPreviousPage: type: boolean hasNextPage: type: boolean startCursor: description: Any type endCursor: description: Any type total: type: integer required: - hasPreviousPage - hasNextPage - total title: ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaPageInfo ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaAttributes: type: object properties: {} title: ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaAttributes Projects_findAll_Response_200: type: object properties: edges: type: array items: $ref: >- #/components/schemas/ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaEdgesItems pageInfo: $ref: >- #/components/schemas/ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaPageInfo attributes: $ref: >- #/components/schemas/ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaAttributes required: - edges - pageInfo - attributes title: Projects_findAll_Response_200 ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaItemsContext: type: object properties: customerId: type: string format: uuid title: >- ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaItemsContext ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaItems: type: object properties: message: type: string code: type: string type: type: string context: $ref: >- #/components/schemas/ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaItemsContext required: - message - code - type title: ApiV1AccountIdProjectsGetResponsesContentApplicationJsonSchemaItems ``` ## Examples **Response** ```json { "edges": [ { "cursor": "W1sicHJvamVjdF9fY3JlYXRlZEF0IiwiMTY3MjUzMTIwMDAwMCJdXQ==", "node": { "id": "185071d5-d4fe-4bea-93df-19d0bd8c2d0d", "customerId": "c415a474-be24-11eb-8529-0242ac130003", "name": "Nemiga", "url": "https://nemiga.org", "siteKey": "e610df2f-2ab3-48b3-90a0-4502b10e1e98", "serverKey": "ee6c6c65-b696-43a1-8ed1-624f67dc3fc8", "isProtected": false, "rules": { "order": [], "rules": [] }, "rateLimits": { "order": [], "rateLimits": [] }, "phishingInfo": { "originalUrl": "https://nemiga.org", "action": "IGNORE", "allowedUrls": [] }, "responseExtraFields": [], "updatedAt": "1672531200000", "createdAt": "1672531200000" } }, { "cursor": "W1sicHJvamVjdF9fY3JlYXRlZEF0IiwiMTY3MjYxNzYwMDAwMCJdXQ==", "node": { "id": "5c53992b-30b7-4ac0-99e6-b36492857f03", "customerId": "c415a474-be24-11eb-8529-0242ac130003", "name": "Varka", "url": "https://varka.org", "siteKey": "43de1194-80dc-466f-b027-01b552d0a7ed", "serverKey": "446a046c-3b60-4694-b6ca-07c0e1dc76d5", "isProtected": false, "rules": { "order": [], "rules": [] }, "rateLimits": { "order": [], "rateLimits": [] }, "phishingInfo": { "originalUrl": "https://varka.org", "action": "IGNORE", "allowedUrls": [] }, "responseExtraFields": [], "updatedAt": "1672617600000", "createdAt": "1672617600000" } }, { "cursor": "W1sicHJvamVjdF9fY3JlYXRlZEF0IiwiMTcyNDE2MDI0MTg2NCJdXQ==", "node": { "id": "01916ff5-70c8-7f01-a0c3-701d23966866", "customerId": "c415a474-be24-11eb-8529-0242ac130003", "name": "test", "url": "http://test.com", "siteKey": "01916ff5-70c8-7f01-a0c4-5a03fd5b3969", "serverKey": "01916ff5-70c8-7f01-a0c5-df33dc41009d", "isProtected": false, "rules": { "order": [], "rules": [] }, "rateLimits": { "order": [], "rateLimits": [] }, "phishingInfo": { "originalUrl": "http://test.com", "action": "IGNORE", "allowedUrls": [] }, "responseExtraFields": [], "updatedAt": "1724160241864", "createdAt": "1724160241864" } } ], "pageInfo": { "hasPreviousPage": false, "hasNextPage": false, "total": 3 }, "attributes": {} } ``` **SDK Code** ```python Projects_findAll_example import requests url = "https://{base_url}/api/v1/account_id/projects" querystring = {"cursor":"","where":"","order_by":""} response = requests.get(url, params=querystring) print(response.json()) ``` ```javascript Projects_findAll_example const url = 'https://{base_url}/api/v1/account_id/projects?cursor=&where=&order_by='; const options = {method: 'GET'}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Projects_findAll_example package main import ( "fmt" "net/http" "io" ) func main() { url := "https://{base_url}/api/v1/account_id/projects?cursor=&where=&order_by=" req, _ := http.NewRequest("GET", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Projects_findAll_example require 'uri' require 'net/http' url = URI("https://{base_url}/api/v1/account_id/projects?cursor=&where=&order_by=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```java Projects_findAll_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://{base_url}/api/v1/account_id/projects?cursor=&where=&order_by=") .asString(); ``` ```php Projects_findAll_example request('GET', 'https://{base_url}/api/v1/account_id/projects?cursor=&where=&order_by='); echo $response->getBody(); ``` ```csharp Projects_findAll_example using RestSharp; var client = new RestClient("https://{base_url}/api/v1/account_id/projects?cursor=&where=&order_by="); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` ```swift Projects_findAll_example import Foundation let request = NSMutableURLRequest(url: NSURL(string: "https://{base_url}/api/v1/account_id/projects?cursor=&where=&order_by=")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```