find all
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" },
"domain": { "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" }
}
},
"cdnConfig": { "type": ["object", "null"] },
"phishingIntegrationConfig": { "type": ["object", "null"] },
"captchaConfig": { "type": ["object", "null"] },
"responseExtraFields": { "type": "array" },
"updatedAt": { "type": "string" },
"createdAt": { "type": "string" },
"subscriptionId": { "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" }
}
}
```
> **Accepted permissions**
> `Account → Projects → Projects list`
>
> **Token scope**
> `Account Projects View`
Authentication
X-Api-Keystring
Personal access token. Create it in your BotBye account under **Profile → Personal Access Tokens**, tick the scopes the endpoints you call require (see each endpoint's **Token scope**), and send the token in the `X-Api-Key` request header. A token works only for the account it was created in.
Path parameters
account_id
Query parameters
cursor
(Optional): a cursor for pagination.
- `after` (string): Pointer to the item after which the items are to be retrieved.
- `before` (string): Pointer to the item before which the items are to be retrieved.
where
(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).
- `predicate` (string): The filtering condition (e.g., `gte`, `lte`, `eq` for a leaf or `and`, `or` for a branch). Possible values [[#Predicate]]
- `opearands` (string): A list of nested conditions (used only for branches, such as `and`, `or`).
- `fieldPath` (string): The field to which the filtering condition is applied (used only for a leaf. Each entity has its own fieldPath list).
- `value` (string): The value to compare against the field (used only for a leaf).
order_by
(Optional): property by which to order by.
- `fieldPath` (string): name of order field.
- `direction` (string): `ASC` or `DESC`
limit
(Optional): specifies the maximum number of results to return in a single response. By default - 20, max - 100.
Response headers
Content-Length
Connection
Response
success
edges
pageInfo
attributes
Errors
400
Bad Request Error