Bevor logo
SupportDashboard
GuidesAPI ReferenceCLI ReferenceSDK Reference
Python

Projects

Python SDK reference for the projects resource

Note

The Bevor SDK is coming soon. This page previews its planned Python interface.

Access this resource from client.projects. Both async and sync clients expose the same methods.

get

GET /business/projects/{project_id}

result = await client.projects.get(
    project_id=project_id,
)

Arguments:

project_idIDpathrequired

Returns: ProjectSchema

show properties (11)hide properties (11)
idstringrequired
created_atstringrequired
namestringrequired
slugstringrequired
descriptionOptional[string]
tagsarray of string
n_codesintegerrequired
n_analysesintegerrequired
team_idstringrequired
created_by_userUserSchemarequired
show properties (4)hide properties (4)
idstringrequired
is_selfbooleanrequired
created_atstringrequired
usernamestringrequired
github_linkOptional[GithubLinkSchema]
show properties (6)hide properties (6)
idintegerrequired
namestringrequired
is_privatebooleanrequired
accountGithubAccountSchemarequired
show properties (4)hide properties (4)
idintegerrequired
loginstringrequired
typestringrequired
avatar_urlstringrequired
push_events_enabledbooleanrequired
branch_filtersarray of GithubBranchFilterMap
show properties (2)hide properties (2)
patternstringrequired
is_enabledbooleanrequired

list

GET /business/projects

result = await client.projects.list()

Arguments:

optionsProjectQueryParams | Nonequery
default:None

ProjectQueryParams

pageOptional[integer]
page_sizeOptional[integer]
order_byOptional['created_at' | 'updated_at']
orderOptional['desc' | 'asc']
nameOptional[string]
tagOptional[string]
with_paginationboolquery
default:False

Return type by call:

  • with_pagination=True → PaginatedResource[ProjectSchema]
  • with_pagination=False → Pagination[ProjectSchema]
show properties (6)hide properties (6)
resultsarray of ProjectSchema
show properties (11)hide properties (11)
idstringrequired
created_atstringrequired
namestringrequired
slugstringrequired
descriptionOptional[string]
tagsarray of string
n_codesintegerrequired
n_analysesintegerrequired
team_idstringrequired
created_by_userUserSchemarequired
show properties (4)hide properties (4)
idstringrequired
is_selfbooleanrequired
created_atstringrequired
usernamestringrequired
github_linkOptional[GithubLinkSchema]
show properties (6)hide properties (6)
idintegerrequired
namestringrequired
is_privatebooleanrequired
accountGithubAccountSchemarequired
show properties (4)hide properties (4)
idintegerrequired
loginstringrequired
typestringrequired
avatar_urlstringrequired
push_events_enabledbooleanrequired
branch_filtersarray of GithubBranchFilterMap
show properties (2)hide properties (2)
patternstringrequired
is_enabledbooleanrequired
pageintegerrequired
page_sizeintegerrequired
morebooleanrequired
total_observationsintegerrequired
total_pagesintegerrequired

create

POST /business/projects

result = await client.projects.create()

Arguments:

bodyCreateProjectBodyDict | Nonebody
default:None

CreateProjectBodyDict

nameOptional[string]
descriptionOptional[string]
tagsOptional[array of string]

Returns: ProjectSchema

show properties (11)hide properties (11)
idstringrequired
created_atstringrequired
namestringrequired
slugstringrequired
descriptionOptional[string]
tagsarray of string
n_codesintegerrequired
n_analysesintegerrequired
team_idstringrequired
created_by_userUserSchemarequired
show properties (4)hide properties (4)
idstringrequired
is_selfbooleanrequired
created_atstringrequired
usernamestringrequired
github_linkOptional[GithubLinkSchema]
show properties (6)hide properties (6)
idintegerrequired
namestringrequired
is_privatebooleanrequired
accountGithubAccountSchemarequired
show properties (4)hide properties (4)
idintegerrequired
loginstringrequired
typestringrequired
avatar_urlstringrequired
push_events_enabledbooleanrequired
branch_filtersarray of GithubBranchFilterMap
show properties (2)hide properties (2)
patternstringrequired
is_enabledbooleanrequired

all

GET /business/user/projects

result = await client.projects.all()

Arguments:

optionsProjectQueryParams | Nonequery
default:None

ProjectQueryParams

pageOptional[integer]
page_sizeOptional[integer]
order_byOptional['created_at' | 'updated_at']
orderOptional['desc' | 'asc']
nameOptional[string]
tagOptional[string]

Returns: ResultsResponse[ProjectSchema]

show properties (1)hide properties (1)
resultsarray of ProjectSchema
show properties (11)hide properties (11)
idstringrequired
created_atstringrequired
namestringrequired
slugstringrequired
descriptionOptional[string]
tagsarray of string
n_codesintegerrequired
n_analysesintegerrequired
team_idstringrequired
created_by_userUserSchemarequired
show properties (4)hide properties (4)
idstringrequired
is_selfbooleanrequired
created_atstringrequired
usernamestringrequired
github_linkOptional[GithubLinkSchema]
show properties (6)hide properties (6)
idintegerrequired
namestringrequired
is_privatebooleanrequired
accountGithubAccountSchemarequired
show properties (4)hide properties (4)
idintegerrequired
loginstringrequired
typestringrequired
avatar_urlstringrequired
push_events_enabledbooleanrequired
branch_filtersarray of GithubBranchFilterMap
show properties (2)hide properties (2)
patternstringrequired
is_enabledbooleanrequired

Teams

Codes

On this page

getlistcreateall