Appearance
Get projects.
GET
/backend/v1/projects
Retrieves a list of projects that match the given criteria,
with the option to adjust the limit for more results.
Authorizations
HTTPBearer
TypeHTTP (bearer)
Parameters
Query Parameters
cursor
Selects page for paginated results. Pass in the next or prev attribute in the response
search
Only return results that match the given text.
limit
Limits the amount of results.
Typeinteger
default
10maximum
100minimum
1ascending
Whether results should be sorted in ascending order.
Typeboolean
default
falsetype
Filter projects by these types.
providerId
Filter by projects that have these providers added
sortBy
Sort results by the given parameter.
Typestring
Enum
namecreated_atupdated_atadmin
Get projects that the current user is/isn't admin of.
createdBy
Filter by projects created by the specified user
Responses
Successful Response
application/json
JSON
{
"next": "string",
"prev": "string",
"projects": [
{
"adminCount": 0,
"adminRoleId": "string",
"botType": "string",
"chatbotId": "string",
"config": {
"packages": [
{
"blocking": "string",
"enabled": "string",
"flagMessage": "string",
"force": "string",
"id": "string",
"mode": "string",
"version": "string"
}
],
"providerRouting": "string",
"providers": [
{
"default": "string",
"enabled": true,
"id": "string",
"name": "string",
"type": "string"
}
],
"scanners": [
{
"blocking": "string",
"enabled": "string",
"flagMessage": "string",
"force": "string",
"id": "string",
"mode": "string",
"version": "string"
}
]
},
"createdAt": "string",
"createdBy": "string",
"friendlyId": "string",
"id": "string",
"memberCount": 0,
"memberRoleId": "string",
"name": "string",
"type": "bot",
"updatedAt": "string"
}
]
}