For AI agents: the docs index is at https://developers.gobridgit.com/llms.txt. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Guides API Reference

v1.0

API Reference

Jump to Content

v1.0Guides API Reference

/auth/signin
- Sign in and obtain tokenspost
/auth/token
- Refresh an existing sessionpost

Accounts
AccountTitleCriteria
AccountActivities
- Retrieves activity logs for the specified account with optional filtering and pagination.post
AccountCertifications
AccountGroupings
AccountIntegrations
- Lists integrations for an account with server-side search, filters, and pagination. The `query-has-more` response header signals whether more records exist beyond this page.get
- One integration product for an account: catalog metadata, per-object effective status, the product-level connection state, and the account's instances of it. Statuses derive the same way the list derives them, so the page needs no second call.get
AccountInvitations
AccountUsers
Allocations
ExperienceFields
ExperienceFieldValues
External
HourlyAllocations
HourlyRoleNames
Persons
PersonFieldValue
PersonAttachments
PersonCertAttachments
PersonCertifications
PersonEmploymentPeriods
PersonFields
PersonGroupings
PersonHistoricalExperienceFields
PersonHistoricalExperiences
PersonProfile
PersonTitles
PersonUnavailabilities
Phases
Projects
ProjectFieldValue
ProjectFields
ProjectGroupings
ProjectNotes
ProjectRoles
ProjectHourlyRoles
ProjectRoleCategories
ProjectsPhases
ProjectTasks
ProjectWorkforceSpendReports
- Get the workforce spend reports (salaried only) on hours with breakdown, grouped by role name, period, then by assignee, given the project IDpost
- Get the workforce spend reports (salaried only) on hours with overview on elapsed, remainder, grouped by role name, and assignee, given the project IDpost
RoleAllocations
- Allocates a person to a role on the given account and projectpost
RoleNames
ServiceAccounts
SharedFilters
- Delete a shared filter from the given accountdel
UserFilters
Users
- Modify system user's permission group.put

RoleTags
Unavailabilities
- Adds a period of unavailability to a person, optionally creating backfill allocation segments for specified roles.post

PersonActuals
- Saves hours a timekeeping integration sent for one person, grouped by the job code mapping they were logged against. Callable by the account's Workato service accounts, account admins, and super admins, with the manage-actuals permission.post
PersonPromotionReadiness
- Gets a person's readiness for promotion in the given accountget
ProjectIntegrationMapping
- Lists every external job code mapped to a project, grouped by the integration each belongs to: an account integration in Bench or a source key for one outside it. Each code comes with the mapping id used to sync people's hours against it. Callable by service accounts, super admins, and account admins.get
- Replaces the external job codes mapped to a project for each integration named in the request, either an account integration in Bench or a source key for one outside it. Integrations not named are left alone. Codes missing from a named integration are removed, and codes mapped to another project move to this one. Hours already synced for a removed or moved code are kept as detached weekly hours on the project they were logged against. Callable by service accounts, super admins, and account admins.post

Powered by

Bench API V1

Persons

Updated 14 days ago

Remove hourly role name(s) by ID in the account

Gets all people in the given account.

Did this page help you?

Updated 14 days ago

Remove hourly role name(s) by ID in the account

Gets all people in the given account.

Did this page help you?