{
"opencollection": "1.0.0",
"info": {
"name": "Bench API",
"version": "1.0"
},
"items": [
{
"info": {
"name": "AccountActivities",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieves activity logs for the specified account with optional filtering and pagination.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/activities/_filter",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The account ID (must be greater than zero)"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This endpoint returns a paginated list of activities that occurred within the account. The results can be filtered by:\n- Person IDs (maximum 10)\n- Project IDs (maximum 10)\n- Date range (happenedFrom and happenedTo)\n- User IDs who triggered the events (maximum 10)\n- Activity types (maximum 25)\n\nNote: Either PersonIds or ProjectIds can be specified, but not both simultaneously.\n\nThe response includes a `query-has-more` header indicating whether additional records are available beyond the current p"
}
]
},
{
"info": {
"name": "AccountCertifications",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets the certifications for the given account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/certifications",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Offset for pagination"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of results in this page"
}
]
},
"docs": "
Permissions
Account: Read"
},
{
"info": {
"name": "Adds a certification on the given account.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/certifications",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Account: Write"
},
{
"info": {
"name": "Gets the the specified certification for the given account by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/certifications/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Certification's ID"
}
]
},
"docs": "
Permissions
Account: Read"
},
{
"info": {
"name": "Updates a certification for the given account",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/certifications/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "Id of the certification to update"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Account: Write"
},
{
"info": {
"name": "Deletes a certification from the given account",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/certifications/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "Id of the certification to remove"
}
]
},
"docs": "NOTE: this will delete all linked attachments to person certifications.
Permissions
Account: Write
Private: Read"
}
]
},
{
"info": {
"name": "AccountGroupings",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets the groupings for the given account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/groupings",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Offset for pagination"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of results in the resultset"
}
]
},
"docs": "
Permissions
Account: Read"
},
{
"info": {
"name": "Adds a grouping on the given account.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/groupings",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Account: Write"
},
{
"info": {
"name": "Gets the the specified grouping for the given account by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/groupings/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The grouping's ID"
}
]
},
"docs": "
Permissions
Account: Read"
},
{
"info": {
"name": "Updates a grouping for the given account",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/groupings/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "Id of the grouping to update"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Account: Write"
},
{
"info": {
"name": "Deletes a grouping from the given account",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/groupings/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "Id of the grouping to remove"
}
]
},
"docs": "
Permissions
Account: Write"
}
]
},
{
"info": {
"name": "AccountInvitations",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets all invitations for an account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/invitations",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The ID of the account"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Offset for pagination"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Number of invitations to pull at a time"
}
]
},
"docs": "
Permissions
Account: Read"
},
{
"info": {
"name": "Sends an join invitation to the given email for an account",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/invitations",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The ID of the account"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Account: Write"
},
{
"info": {
"name": "Removes the account's invitation by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/invitations/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The account Id"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Invitation Id"
}
]
},
"docs": "
Permissions
Account: Write"
}
]
},
{
"info": {
"name": "AccountUsers",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets the users for the given account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/users",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Offset for pagination"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of results in this page"
},
{
"name": "group",
"value": "",
"type": "query",
"description": "Optional parameter to filter results based on user groups"
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "(Optional) Filters the result to contain account users that match the ids passed in."
},
{
"name": "nameSearch",
"value": "",
"type": "query",
"description": "(Optional) Searches for users by partial name match (minimum 3 characters)."
}
]
},
"docs": "
Permissions
Account: Read"
},
{
"info": {
"name": "Gets the the specified user for the given account by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/users/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The User's ID"
}
]
},
"docs": "
Permissions
Account: Read"
},
{
"info": {
"name": "Updates a user for the given account",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/users/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "Id of the user to update"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Name or Title can be null, but they cannot be empty/whitespace. If null the value will not be changed.
Permissions
Account: Write"
},
{
"info": {
"name": "Deactivates a user from the given account",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/users/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "Id of the user to remove"
}
]
},
"docs": "Adminsitrators can only deactivate other users from the account and not themselves.
Permissions
Account: Write"
},
{
"info": {
"name": "Modify user's permission group in the account.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/users/:id/membership",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to modify"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Groups in the account can be fetched from the api/v{version}/accounts/{accountId}/groups endpoint.
Permissions
Account: Write"
},
{
"info": {
"name": "Resets a user's authentication method and sends a new invitation email.\nThis can be used to switch a user from SSO to username/password authentication.\nNote: users can be on multiple accounts in an organization. This resets the auth method in all accounts within\nthe organization.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/users/:userId/reset-auth-method",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The account that is currently calling this method."
},
{
"name": "userId",
"value": "",
"type": "path",
"description": "The ID of the account user."
}
]
},
"docs": "
Permissions
Account: Write"
}
]
},
{
"info": {
"name": "Accounts",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get all accounts that the user has access to.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/Accounts",
"params": [
{
"name": "offset",
"value": "",
"type": "query",
"description": "Offset for pagination"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of results in this page"
}
]
},
"docs": "Get all accounts that the user has access to."
},
{
"info": {
"name": "Get all accounts that the user has access to, filter by name (contains), account ids, organization ids, and/or account states (0 = Active, 1 = Deactivated, 2 = All).\nSort options include: name = 0, numProjects = 1, numPeople = 2, numMembers = 3 and organizationId = 4\nSort order options include: asc = 0, desc = 1",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/Accounts/_filter",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "NOTE: Paging limit defaults to 50, and is maximized at 100 items per request. If there are more accounts than were returned, there will be a \"query-has-more\" header that will be set to true."
},
{
"info": {
"name": "Gets details for the given account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/Accounts/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The Account ID"
}
]
},
"docs": "
Permissions
Account: Read"
},
{
"info": {
"name": "Get all custom field values for all people for the given account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/Accounts/:id/person-field-values",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "includeEmpty",
"value": "",
"type": "query",
"description": "If true, the response will include all person field values, even if no value is set for a given field. If false, field values that are empty are not included in the response."
},
{
"name": "state",
"value": "",
"type": "query",
"description": "If specified and non-zero, only include field vlaues for people matching the given state. The available values are defined as follows:\n- active: include only Active people\n- deactivated: include only Deactivated people\n- all: include all people, regardless of state"
},
{
"name": "personIds",
"value": "",
"type": "query",
"description": "Optional paramater of comma delimited ids for filtering results based on the person IDs provided"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "The offset of the result to begin with"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Optional - The number of items return by result set. If no limit given, return all results"
},
{
"name": "employeeId",
"value": "",
"type": "query",
"description": "Optional - for filtering result by system field \"Employee ID\""
}
]
},
"docs": "
Permissions
HourlyProfile: Read
Person: Read
Private: Read
Finance: Read"
},
{
"info": {
"name": "Get all custom field values for all projects for the given account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/Accounts/:id/project-field-values",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "includeEmpty",
"value": "",
"type": "query",
"description": "If true, the response will include all project field values, even if no value is set for a given field. If false, field values that are empty are not included in the response."
},
{
"name": "projectIds",
"value": "",
"type": "query",
"description": "Optional paramater of comma delimited ids for filtering results based on the project IDs provided"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "The offset of the result to begin with"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Optional - The number of items return by result set. If no limit given, return all results"
},
{
"name": "projectNumber",
"value": "",
"type": "query",
"description": "Optional - for filtering result by system field \"Project Number\""
},
{
"name": "externalId",
"value": "",
"type": "query",
"description": "Optional - for filtering result by system field \"External ID\""
},
{
"name": "classification",
"value": "",
"type": "query",
"description": "Optional - for filtering result by classification: All or Experience\""
}
]
},
"docs": "
Permissions
Project: Read
Private: Read
Finance: Read"
},
{
"info": {
"name": "Get all Tasks for all projects in the given account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/Accounts/:id/tasks",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "relativeDate",
"value": "2021-01-01",
"type": "query",
"description": "Optional paramater used to calculate date based properties. If not provided, it is set to today's date in UTC."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Offset for pagination"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of results in this page"
},
{
"name": "projectIds",
"value": "",
"type": "query",
"description": "(Optional) Filter task(s) to contain tasks that match the projectIds passed in."
},
{
"name": "projectState",
"value": "",
"type": "query",
"description": "(Optional) Filters the result by the state of the project the role is on"
},
{
"name": "taskIds",
"value": "",
"type": "query",
"description": "(Optional) Filters the result to contain tasks that match the taskIds passed in. Works as an AND with filledState and roleNameIds"
},
{
"name": "filledState",
"value": "",
"type": "query",
"description": "(Optional) Filters the result by the filled state of the roles"
},
{
"name": "roleIds",
"value": "",
"type": "query",
"description": "(Optional) Filters the result to contain roles that match the ids passed in. Works as an AND with filledState and roleNameIds"
},
{
"name": "roleNameIds",
"value": "",
"type": "query",
"description": "(Optional) Filters the result to contain roles that match the ids passed in. Works as an AND with filledState and roleIds"
},
{
"name": "roleState",
"value": "",
"type": "query",
"description": "(Optional) Filters the result by the state of the role dates: Current, Upcoming, Past, or All"
}
]
},
"docs": "
Permissions
Project: Read
Person: Read
Role: Read
Allocation: Read"
},
{
"info": {
"name": "Get all categories for all projects in the given account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/Accounts/:id/role-categories",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Offset for pagination"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of results in this page"
}
]
},
"docs": "
Permissions
Project: Read
Role: Read
HourlyRole: Read"
},
{
"info": {
"name": "Get all Salaried roles for all projects in the given account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/Accounts/:id/roles",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "relativeDate",
"value": "2021-01-01",
"type": "query",
"description": "Optional paramater used to calculate date based properties. If not provided, it is set to today's date in UTC."
},
{
"name": "unfilled",
"value": "",
"type": "query",
"description": "If true, limits the results to include only roles that are unfilled; that is, they don't have any allocations. If false, the results include all roles in the account, both filled and unfilled."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Offset for pagination"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of results in this page"
},
{
"name": "projectId",
"value": "",
"type": "query",
"description": "(Optional) Filter role(s) for specified project ID"
},
{
"name": "filledState",
"value": "",
"type": "query",
"description": "(Optional) Filters the result by the filled state of the roles"
},
{
"name": "roleIds",
"value": "",
"type": "query",
"description": "(Optional) Filters the result to contain roles that match the ids passed in. Works as an AND with filledState and roleNameIds"
},
{
"name": "roleNameIds",
"value": "",
"type": "query",
"description": "(Optional) Filters the result to contain roles that match the ids passed in. Works as an AND with filledState and roleIds"
},
{
"name": "projectState",
"value": "",
"type": "query",
"description": "(Optional) Filters the result by the state of the project the role is on"
},
{
"name": "roleState",
"value": "",
"type": "query",
"description": "(Optional) Filters the result by the state of the role dates: Current, Upcoming, Past, or All"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "(Optional)Salaried role type to filter results by (Defaults to Operations)"
}
]
},
"docs": "
Permissions
Role: Read
Finance: Read"
},
{
"info": {
"name": "Get all Hourly roles for all projects in the given account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/Accounts/:id/hourly-roles",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "relativeDate",
"value": "2021-01-01",
"type": "query",
"description": "Optional paramater used to calculate date based properties. If not provided, it is set to today's date in UTC."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Offset for pagination"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of results in this page"
},
{
"name": "projectId",
"value": "",
"type": "query",
"description": "(Optional) Filter role(s) for specified project ID"
},
{
"name": "filledState",
"value": "",
"type": "query",
"description": "(Optional) Filters the result by the filled state of the roles"
},
{
"name": "roleIds",
"value": "",
"type": "query",
"description": "(Optional) Filters the result to contain roles that match the ids passed in. Works as an AND with filledState and roleNameIds"
},
{
"name": "roleNameIds",
"value": "",
"type": "query",
"description": "(Optional) Filters the result to contain roles that match the ids passed in. Works as an AND with filledState and roleIds"
},
{
"name": "projectState",
"value": "",
"type": "query",
"description": "(Optional) Filters the result by the state of the project the role is on"
},
{
"name": "roleState",
"value": "",
"type": "query",
"description": "(Optional) Filters the result by the state of the role dates: Current, Upcoming, Past, or All"
}
]
},
"docs": "
Permissions
HourlyRole: Read
Finance: Read"
},
{
"info": {
"name": "Gets the persons certifications for the given account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/Accounts/:id/person-certifications",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "personIds",
"value": "",
"type": "query",
"description": "Optional paramater of comma delimited ids for filtering results based on the person IDs provided"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Offset for pagination"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of results in this page"
}
]
},
"docs": "
Permissions
HourlyProfile: Read
Person: Read
Private: Read"
},
{
"info": {
"name": "Gets the user profiles for the given account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/Accounts/:id/user-profiles",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Offset for pagination"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of results in this page"
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "(Optional) Filters the result to contain account users that match the ids passed in."
}
]
},
"docs": "
Permissions
Account: Read"
},
{
"info": {
"name": "Query the account for instances where two or more persons have collaborated on the same project",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/Accounts/:id/collaboration-matrix/_filter",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The account ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "When a project ID is supplied, the results will be constrained to the persons within that project.\n\nIf the project ID is omitted, the results will pull for the entire account and can be filtered by person IDs.
Permissions
Role: Read
Allocation: Read
Person: Read
HourlyRole: Read
HourlyAllocation: Read"
}
]
},
{
"info": {
"name": "Allocations",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets the allocations for roles in the given account and project",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/Allocations",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID"
},
{
"name": "relativeDate",
"value": "2021-01-01",
"type": "query",
"description": "Optional paramater used to calculate date based properties. If not provided, it is set to today's date in UTC."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Offset for pagination"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of results in this page"
},
{
"name": "personstate",
"value": "",
"type": "query",
"description": "State of persons to filter results by (Default Active)"
},
{
"name": "daysUntilTimeOff",
"value": "",
"type": "query",
"description": "Used to calculate the upcoming TimeOff unavailabilities based on the relativeDate"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Salaried role type to filter results by (Default to Operations)"
}
]
},
"docs": "
Permissions
Person: Read
Role: Read
Allocation: Read
Private: Read
Finance: Read"
},
{
"info": {
"name": "Allocates a person to a role on the given account and project",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/Allocations",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "A person cannot be allocated entirely inside a period of unavailability and cannot be allocated outside of their employment dates.\n\nFor allocations that overlap a period of unavailability, the API will truncate or not set the date range that the person is unavailable.\n\nExamples: Unavaialble from 2020-01-11 to 2020-01-25, Allocation date from 2020-01-20 to 2020-03-31, will alocate the person from 2020-01-26 to 2020-03-31\n\nUnavaialble from 2020-01-11 to 2020-01-25, Allocation date from 2020-01-01 "
},
{
"info": {
"name": "Updates a person's allocation on a role on the given account and project",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/Allocations",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "A person cannot be allocated entirely inside a period of unavailability and cannot be allocated outside of their employment dates.\n\nFor allocations that overlap a period of unavailability, the API will truncate or not set the date range that the person is unavailable.\n\nExamples: Unavaialble from 2020-01-11 to 2020-01-25, Allocation date from 2020-01-20 to 2020-03-31, will alocate the person from 2020-01-26 to 2020-03-31\n\nUnavaialble from 2020-01-11 to 2020-01-25, Allocation date from 2020-01-01 "
},
{
"info": {
"name": "Removes a person's allocation on a role on the given account and project",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/Allocations",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "The request must contain the role id, person id, start and end date to ensure that the role and allocation is correct and hasn't been modified before trying to delete it.
Permissions
Person: Read
Role: Read
Allocation: Write"
}
]
},
{
"info": {
"name": "ExperienceFieldValues",
"type": "folder"
},
"items": [
{
"info": {
"name": "Query all existing values for an experience field",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/experience-fields/:experienceFieldId/values",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "experienceFieldId",
"value": "",
"type": "path",
"description": "The Experience Field UUID"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Offset value for paging results"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results per page"
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Filter by name with a contains check not exact match"
}
]
},
"docs": "
Permissions
Account: Read"
},
{
"info": {
"name": "Create new experience field values",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/experience-fields/:experienceFieldId/values",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "experienceFieldId",
"value": "",
"type": "path",
"description": "The Experience Field UUID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Account: Write"
},
{
"info": {
"name": "Update a value for an existing experience field",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/experience-fields/:experienceFieldId/values/:experienceFieldValueId",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "experienceFieldId",
"value": "",
"type": "path",
"description": "The Experience Field UUID"
},
{
"name": "experienceFieldValueId",
"value": "",
"type": "path",
"description": "The Experience Field Value ID UUID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Account: Write"
},
{
"info": {
"name": "Delete an existing experience field value",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/experience-fields/:experienceFieldId/values/:experienceFieldValueId",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "experienceFieldId",
"value": "",
"type": "path",
"description": "The Experience Field UUID"
},
{
"name": "experienceFieldValueId",
"value": "",
"type": "path",
"description": "The Field Value ID UUID"
}
]
},
"docs": "
Permissions
Account: Write"
}
]
},
{
"info": {
"name": "ExperienceFields",
"type": "folder"
},
"items": [
{
"info": {
"name": "Query all experience fields for an account.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/experience-fields",
"params": [
{
"name": "accountId",
"value": "",
"type": "path"
}
]
},
"docs": "
Permissions
Account: Read"
},
{
"info": {
"name": "Promote custom fields to experience fields",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/experience-fields",
"params": [
{
"name": "accountId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Account: Write"
},
{
"info": {
"name": "Query candidate experience fields for an account.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/experience-fields/candidates",
"params": [
{
"name": "accountId",
"value": "",
"type": "path"
}
]
},
"docs": "
Permissions
Account: Write"
},
{
"info": {
"name": "Demote experience fields",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/experience-fields/:experienceFieldId",
"params": [
{
"name": "accountId",
"value": "",
"type": "path"
},
{
"name": "experienceFieldId",
"value": "",
"type": "path"
}
]
},
"docs": "
Permissions
Account: Write"
}
]
},
{
"info": {
"name": "External",
"type": "folder"
},
"items": [
{
"info": {
"name": "External_GetPerson",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/external/persons/:externalId",
"params": [
{
"name": "accountId",
"value": "",
"type": "path"
},
{
"name": "externalId",
"value": "",
"type": "path"
}
]
}
},
{
"info": {
"name": "External_GetProject",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/external/projects/:externalId",
"params": [
{
"name": "accountId",
"value": "",
"type": "path"
},
{
"name": "externalId",
"value": "",
"type": "path"
}
]
}
},
{
"info": {
"name": "External_GetProjectRole",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/external/roles/:externalId",
"params": [
{
"name": "accountId",
"value": "",
"type": "path"
},
{
"name": "externalId",
"value": "",
"type": "path"
}
]
}
}
]
},
{
"info": {
"name": "HourlyAllocations",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets the allocations for hourly roles in the given account and project",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/hourly-allocations",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID"
},
{
"name": "relativeDate",
"value": "2021-01-01",
"type": "query",
"description": "Optional paramater used to calculate date based properties. If not provided, it is set to today's date in UTC."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Offset for pagination"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of results in this page"
},
{
"name": "personstate",
"value": "",
"type": "query",
"description": "State of persons to filter results by (Default Active)"
},
{
"name": "daysUntilTimeOff",
"value": "",
"type": "query",
"description": "Used to calculate the upcoming TimeOff unavailabilities based on the relativeDate"
}
]
},
"docs": "
Permissions
HourlyProfile: Read
HourlyRole: Read
HourlyAllocation: Read
Private: Read
Finance: Read"
},
{
"info": {
"name": "Allocates an hourly person to an hourly role on the given account and project",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/hourly-allocations",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "A person cannot be allocated entirely inside a period of unavailability and cannot be allocated outside of their employment dates.\n\nFor allocations that overlap a period of unavailability, the API will truncate or not set the date range that the person is unavailable.\n\nExamples: Unavaialble from 2020-01-11 to 2020-01-25, Allocation date from 2020-01-20 to 2020-03-31, will alocate the person from 2020-01-26 to 2020-03-31\n\nUnavaialble from 2020-01-11 to 2020-01-25, Allocation date from 2020-01-01 "
},
{
"info": {
"name": "Updates an hourly person's allocation on an hourly role on the given account and project",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/hourly-allocations",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "An hourly person cannot be allocated entirely inside a period of unavailability and cannot be allocated outside of their employment dates.\n\nFor allocations that overlap a period of unavailability, the API will truncate or not set the date range that the person is unavailable.\n\nExamples: Unavaialble from 2020-01-11 to 2020-01-25, Allocation date from 2020-01-20 to 2020-03-31, will alocate the hourly person from 2020-01-26 to 2020-03-31\n\nUnavaialble from 2020-01-11 to 2020-01-25, Allocation date f"
},
{
"info": {
"name": "Removes an hourly person's allocation on a role on the given account and project",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/hourly-allocations",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "The request must contain the role id, person id, start and end date to ensure that the role and allocation is correct and hasn't been modified before trying to delete it.
Permissions
HourlyProfile: Write
HourlyRole: Write
HourlyAllocation: Write"
}
]
},
{
"info": {
"name": "HourlyRoleNames",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get hourly role names in the account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:id/hourly-role-names",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The account ID"
}
]
},
"docs": "
Permissions
Account: Read
Finance: Read
HourlyRole: Read"
},
{
"info": {
"name": "Add/Update hourly role name(s) in the account",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:id/hourly-role-names",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The account ID"
},
{
"name": "alphabetize",
"value": "",
"type": "query",
"description": "Optional flag to set whether role names should be alphabetically ordered by the caller"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "If \"alphabetize\" parameter flag is true, the role names should be alphabetically ordered by caller, otherwise in the order of the request.\n\nTo add or update role names you must have permissions to manage account properties.
Permissions
Account: Write
HourlyRole: Write"
},
{
"info": {
"name": "Remove hourly role name(s) by ID in the account",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:id/hourly-role-names",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The account ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "To remove hourly role names you must have permissions to manage account properties.\nNOTE: The account must contain at least 1 role name.
Permissions
Account: Write
HourlyRole: Write"
}
]
},
{
"info": {
"name": "PersonAttachments",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets the attachments for the given person",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/attachments",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The Person ID"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Offset for pagination"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of results in this page"
},
{
"name": "state",
"value": "",
"type": "query",
"description": "The state of the attachment for filter"
},
{
"name": "creatorId",
"value": "",
"type": "query",
"description": "The ID of attachment creator for filter"
}
]
},
"docs": "
Permissions
Person: Read
HourlyProfile: Read
Private: Read"
},
{
"info": {
"name": "Add an attachment to a person.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/attachments",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The person ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "User needs either Person:Write or HourlyProfile:Write or PeopleCerts:Write or HourlyPeopleCerts:Write permissions depending on the person type to add an attachment.
Permissions
Person: Write
HourlyProfile: Write
PeopleCerts: Write
HourlyPeopleCerts: Write
Private: Read"
},
{
"info": {
"name": "Get a person's attachment by ID.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/attachments/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The person ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The attachment ID"
}
]
},
"docs": "
Permissions
Person: Read
HourlyProfile: Read
Private: Read"
},
{
"info": {
"name": "Delete an attachment from a person.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/attachments/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The person ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The attachment ID"
}
]
},
"docs": "User needs either Person:Write or HourlyProfile:Write or PeopleCerts:Write or HourlyPeopleCerts:Write permissions depending on the person type to delete an attachment.
Permissions
Person: Write
HourlyProfile: Write
PeopleCerts: Write
HourlyPeopleCerts: Write
Private: Read"
}
]
},
{
"info": {
"name": "PersonCertAttachments",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get all attachments for a person's certification.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/certifications/:certId/attachments",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The person ID"
},
{
"name": "certId",
"value": "",
"type": "path",
"description": "The certification ID"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "The offset for paging response"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The amount of items in the response"
},
{
"name": "state",
"value": "",
"type": "query",
"description": "The state of the attachment for filter"
},
{
"name": "creatorId",
"value": "",
"type": "query",
"description": "The ID of attachment creator for filter"
}
]
},
"docs": "
Permissions
Person: Read
HourlyProfile: Read
PersonCerts: Read
HourlyCerts: Read
Private: Read"
},
{
"info": {
"name": "Link an attachment to a person's certification.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/certifications/:certId/attachments",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The person ID"
},
{
"name": "certId",
"value": "",
"type": "path",
"description": "The certification ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Person: Read
HourlyProfile: Read
Private: Read
PersonCerts: Write
HourlyCerts: Write"
},
{
"info": {
"name": "Get an attachment by ID for a person's certification.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/certifications/:certId/attachments/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The person ID"
},
{
"name": "certId",
"value": "",
"type": "path",
"description": "The certification ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The attachment ID"
}
]
},
"docs": "
Permissions
Person: Read
HourlyProfile: Read
PersonCerts: Read
HourlyCerts: Read
Private: Read"
},
{
"info": {
"name": "Unlink an attachment from a person's certification.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/certifications/:certId/attachments/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The person ID"
},
{
"name": "certId",
"value": "",
"type": "path",
"description": "The certification ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The attachment ID"
}
]
},
"docs": "
Permissions
Person: Read
HourlyProfile: Read
Private: Read
PersonCerts: Write
HourlyCerts: Write"
}
]
},
{
"info": {
"name": "PersonCertifications",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets the certifications for the given person",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/certifications",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The Person ID"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Offset for pagination"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of results in this page"
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "(Optional) Filters the result to contain person certifications that match the ids passed in."
}
]
},
"docs": "
Permissions
Person: Read
HourlyProfile: Read
PersonCerts: Read
HourlyCerts: Read
Private: Read"
},
{
"info": {
"name": "Adds a certification on the given person.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/certifications",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The Person ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Person: Read
HourlyProfile: Read
PersonCerts: Write
HourlyCerts: Write"
},
{
"info": {
"name": "Gets the specified certification for the given person by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/certifications/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The Person ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Certification's ID"
}
]
},
"docs": "
Permissions
Person: Read
HourlyProfile: Read
PersonCerts: Read
HourlyCerts: Read
Private: Read"
},
{
"info": {
"name": "Updates a certification for the given person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/certifications/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The Person ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "Id of the certification to update"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Person: Read
HourlyProfile: Read
PersonCerts: Write
HourlyCerts: Write"
},
{
"info": {
"name": "Deletes a certification from the given person and the linked attachments",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/certifications/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The Person ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "Id of the certification to remove"
}
]
},
"docs": "NOTE: this will delete all linked attachments.
Permissions
Person: Read
HourlyProfile: Read
Private: Read
PersonCerts: Write
HourlyCerts: Write"
}
]
},
{
"info": {
"name": "PersonFieldValue",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets all custom field values for the given person.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/person-field-values",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The Person ID"
},
{
"name": "includeEmpty",
"value": "",
"type": "query",
"description": "If true, the response will include all person field values, even if no value is set for a given field. If false, field values that are empty are not included in the response."
}
]
},
"docs": "
Permissions
Person: Read
HourlyProfile: Read
Private: Read
Finance: Read"
},
{
"info": {
"name": "Add or update one or more custom field values on a person",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/person-field-values",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The Person ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "It is mandatory that the fields with isRequired set to true be passed in as part of the request.\n\n\nExample: Say you have 2 person fields on an account \"Contact Number\" and \"Certifications\" where isRequired is set to true on \"Contact Number\".\n\nFieldDefinition Example Response - GET PersonFields (/api/v{version}/accounts/{id}/person-fields)\n[
{
\"id\": 1394,
\"name\": \"Contact Number\",
&n"
},
{
"info": {
"name": "Update field values on a person",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/person-field-values",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The Person ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validation
\nSingle List Selection: A list where only 1 value can be selected. When creating the list, each value should be between 1 and 250 non-empty characters.\n\nMulti List Selection: A list where 0 or more values can be selected. When creating the list, each value should be between 1 and 250 non-empty characters.\n\nText: Min length: 0. Max length: 250\n\nDate selector: Format: dd/MM/yyyy\n\nOther: Max length: 2400\n\nCheckbox: Accepted values: ```tru"
},
{
"info": {
"name": "Delete one or more custom field values for a person",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/person-field-values",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The Person ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Person: Write
HourlyProfile: Write
Private: Read
Finance: Read"
},
{
"info": {
"name": "Update a single field's value(s) for person in the given account.",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/person-field-values/:fieldId",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The Person ID"
},
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "The field ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validation
\nSingle List Selection: A list where only 1 value can be selected. When creating the list, each value should be between 1 and 250 non-empty characters.\n\nMulti List Selection: A list where 0 or more values can be selected. When creating the list, each value should be between 1 and 250 non-empty characters.\n\nText: Min length: 0. Max length: 250\n\nDate selector: Format: dd/MM/yyyy\n\nOther: Max length: 2400\n\nCheckbox: Accepted values: ```tru"
}
]
},
{
"info": {
"name": "PersonFields",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get all the person field definitions on the given account.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:id/person-fields",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The account ID"
}
]
},
"docs": "
Permissions
Account: Read
Private: Read
Finance: Read
Person: Read
HourlyProfile: Read"
},
{
"info": {
"name": "Adds or updates person field definitions on the given account.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:id/person-fields",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "If you pass in a FieldDefRequest object without an \"id\" this endpoint will add a new one to the account if the name isn't reserved or in use.\n\nIf you pass in a FieldDefRequest object with an \"id\" this endpoint will update an existing one that matches the id.\n\nTo add a value or multiple values to a selection list you must pass an array of \"definedValues\" that contain objects with a \"definedValue\" property of the value you want to add.\n\nTo update a value or multiple values in a selection list you "
},
{
"info": {
"name": "Deletes one or more person field definitions in the given account by ids",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:id/person-fields",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "NOTE: system fields cannot be deleted.
Permissions
Account: Write"
},
{
"info": {
"name": "Update the display order of person field definitions for the given account.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:id/person-fields/_reorder",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The account ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Accepts an array of objects containing fieldId and displayOrder.\n\nSystem fields cannot be reordered and should not be included in the request.\n\nAll custom fields should be included with their new display order values.
Permissions
Account: Write"
}
]
},
{
"info": {
"name": "PersonGroupings",
"type": "folder"
},
"items": [
{
"info": {
"name": "Set grouping to the person in the given account",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/groupings",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The person ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Person: Write
HourlyProfile: Write"
},
{
"info": {
"name": "Update grouping to the person in the given account",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/groupings",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The person ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Person: Write
HourlyProfile: Write"
},
{
"info": {
"name": "Removes grouping from the person in the given account",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/groupings/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The person ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The grouping ID for person"
}
]
},
"docs": "
Permissions
Person: Write
HourlyProfile: Write"
}
]
},
{
"info": {
"name": "PersonHistoricalExperienceFields",
"type": "folder"
},
"items": [
{
"info": {
"name": "Add historical experience field values for a person in an account.\n \nWorth noting that this endpoint is purely additive, i.e. idempotent.\nIt will also ignore field sets for fields that are not found under the account.\nFurthermore, if an experienceFieldValueId is provided, the corresponding value will be ignored.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/historical-experiences/:historicalExperienceId/experience-fields",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The account ID."
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The person ID."
},
{
"name": "historicalExperienceId",
"value": "",
"type": "path",
"description": "The historical experience ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Account: Write"
},
{
"info": {
"name": "Update a historical experience field value for a person in an account.",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/historical-experiences/:historicalExperienceId/experience-fields/:experienceFieldId",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The account ID."
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The person ID."
},
{
"name": "historicalExperienceId",
"value": "",
"type": "path",
"description": "The historical experience ID."
},
{
"name": "experienceFieldId",
"value": "",
"type": "path",
"description": "The experience field ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Account: Write"
},
{
"info": {
"name": "Delete a historical experience field value for a person in an account.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/historical-experiences/:historicalExperienceId/experience-fields/:experienceFieldId",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The account ID."
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The person ID."
},
{
"name": "historicalExperienceId",
"value": "",
"type": "path",
"description": "The historical experience ID."
},
{
"name": "experienceFieldId",
"value": "",
"type": "path",
"description": "The experience field ID."
}
]
},
"docs": "
Permissions
Account: Write"
}
]
},
{
"info": {
"name": "PersonHistoricalExperiences",
"type": "folder"
},
"items": [
{
"info": {
"name": "List historical experience entries for a person.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/historical-experiences",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The account ID."
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The person ID."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "How many to retrieve (1-100, default 50)."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "How many to skip (default 0)."
}
]
},
"docs": "
Permissions
Person: Read"
},
{
"info": {
"name": "Create a new historical experience entry.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/historical-experiences",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The account ID."
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The person ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Account: Write"
},
{
"info": {
"name": "Get a single historical experience entry.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/historical-experiences/:historicalExperienceId",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The account ID."
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The person ID."
},
{
"name": "historicalExperienceId",
"value": "",
"type": "path",
"description": "The historical experience ID."
}
]
},
"docs": "
Permissions
Person: Read"
},
{
"info": {
"name": "Update historical experience entry for a person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/historical-experiences/:historicalExperienceId",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The Person ID"
},
{
"name": "historicalExperienceId",
"value": "",
"type": "path",
"description": "The Historical Experience ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Account: Write"
},
{
"info": {
"name": "Patch historical experience entry for a person",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/historical-experiences/:historicalExperienceId",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The Person ID"
},
{
"name": "historicalExperienceId",
"value": "",
"type": "path",
"description": "The Historical Experience ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Account: Write"
},
{
"info": {
"name": "Delete a historical experience entry.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/historical-experiences/:historicalExperienceId",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The account ID."
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The person ID."
},
{
"name": "historicalExperienceId",
"value": "",
"type": "path",
"description": "The historical experience ID."
}
]
},
"docs": "
Permissions
Account: Write"
}
]
},
{
"info": {
"name": "PersonProfile",
"type": "folder"
},
"items": [
{
"info": {
"name": "Updates a person's profile picture with support for upload and set modes.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/profile-picture",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The unique identifier of the account"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The unique identifier of the person"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Two modes of operation:\n\n1. Upload Mode: When no request body is provided, returns a presigned URL for direct image upload to S3. Use a PUT request to upload your image file to the returned signed URL.\n\n2. Set Mode: When a request body with ImageUrl is provided, sets the profile picture to the specified URL
Permissions
Person: Write
HourlyProfile: Write"
},
{
"info": {
"name": "Clear a person's profile picture",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:personId/profile-picture",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "personId",
"value": "",
"type": "path",
"description": "The Person ID"
}
]
},
"docs": "
Permissions
Person: Write
HourlyProfile: Write"
}
]
},
{
"info": {
"name": "PersonUnavailabilities",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets the periods of unavailability for persons in the given account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/unavailabilities",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Date from which to start the range (Default: 0001-01-01)"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "Date from which to end the range (Default: 9999-12-31)"
},
{
"name": "boundRange",
"value": "",
"type": "query",
"description": "Setting this value to true will truncate the dates returned to the specified start and end date paramters"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Type of the unavailability date range (Default: Unavailability)"
},
{
"name": "state",
"value": "",
"type": "query",
"description": "State of persons to filter results by (Default: Active)"
},
{
"name": "personIds",
"value": "",
"type": "query",
"description": "Optional comma delimited list of person IDs to filter the results if set"
}
]
},
"docs": "By default this endpoint will return only Periods of Unavailability.\nNOTE: If you wish to retrieve Pre and Post employment dates you will need to pass the \"type\" param in the query.\nNOTE: If you do not have Private Read permissions, description will return as null for private periods of unavailability.
Permissions
Person: Read
HourlyProfile: Read
Unavailabilities: Read
HourlyUnavailabilities: Read
Private: Read"
},
{
"info": {
"name": "Gets the periods of unavailability for a person in the given account.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:id/unavailabilities",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "Id of the person to get unavailabilities for"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Date from which to start the range (Default: 0001-01-01)"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "Date from which to end the range (Default: 9999-12-31)"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "The number of items to skip before starting to collect the result set"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of results to return"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The order to return unavailabilities. Default is StartDateAscending"
}
]
},
"docs": "NOTE: If you do not have Private Read permissions, description will return as null for private periods of unavailability.
Permissions
Person: Read
HourlyProfile: Read
Unavailabilities: Read
HourlyUnavailabilities: Read
Private: Read"
},
{
"info": {
"name": "Adds periods of unavailability to a person in the given account",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:id/unavailabilities",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "Id of the person to get unavailabilities for"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Periods of unavailability cannot overlap with employment dates and cannot overlap with existing periods of unavailability.\nNOTE: If you do not have Private Write permissions, you cannot create private periods of unavailability.
Permissions
Private: Write
Person: Read
HourlyProfile: Read
Unavailabilities: Write
HourlyUnavailabilities: Write"
},
{
"info": {
"name": "Updates periods of unavailability to a person in the given account",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:id/unavailabilities",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "Id of the person to get unavailabilities for"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This endpoint will only update the fields that are provided in the objects of the array. Any fields not included will use the existing values.\nNOTE: Periods of unavailability cannot overlap with employment dates and cannot overlap with existing periods of unavailability.\nNOTE: If you do not have Private Write permissions, you can update the start and end date of private periods of unavailability, but not the description or whether it's private.
Permi"
},
{
"info": {
"name": "Removes periods of unavailability from a person in the given account",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/persons/:id/unavailabilities",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "Id of the person to get unavailabilities for"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Person: Read
HourlyProfile: Read
Private: Read
Unavailabilities: Write
HourlyUnavailabilities: Write"
}
]
},
{
"info": {
"name": "Persons",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets all people in the given account.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Persons",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "relativeDate",
"value": "2021-01-01",
"type": "query",
"description": "Optional paramater used to calculate date based properties. If not provided, it is set to today's date in UTC."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Offset for pagination"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of results in this page"
},
{
"name": "email",
"value": "",
"type": "query",
"description": "Filter user with email"
},
{
"name": "state",
"value": "",
"type": "query",
"description": "If specified and not 'Unknown', only include people matching the given state. The available values are defined as follows:\n- Unknown: By default, includes only Active people.\n- Active: include only Active people\n- Deactivated: include only Deactivated people\n- All: include all people, regardless of state"
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "Optional paramater of comma delimited ids for filtering results based on the person IDs provided"
},
{
"name": "uniqueId",
"value": "",
"type": "query",
"description": "Optional paramater of unique identifier for filtering results based on the person unique identifier provided"
}
]
},
"docs": "NOTE: If there are more persons in the account than were returned, there will be a \"query-has-more\" header that will be set to true.
Permissions
HourlyProfile: Read
Person: Read
Finance: Read"
},
{
"info": {
"name": "Add a person to the given account",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Persons",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
HourlyProfile: Write
Person: Write
Private: Read
Finance: Read"
},
{
"info": {
"name": "Gets the number of days until each person in this account is available and their availability ranges for the duration",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Persons/availabilities",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "relativeDate",
"value": "2021-01-01",
"type": "query",
"description": "Optional paramater used to calculate date based properties. If not provided, it is set to today's date in UTC."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start date to filter availabilities from (default today UTC)"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End date to filter availabilities to (default 10 years from today UTC)"
},
{
"name": "boundRange",
"value": "",
"type": "query",
"description": "Setting this value to true will truncate the dates returned to the specified start and end date paramters"
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "Optional paramater of comma delimited ids for filtering results based on the person IDs provided"
},
{
"name": "includeUnavailable",
"value": "",
"type": "query",
"description": "If this is set to true it will return the availabilities and next available dates even if a person doesn't have a next availability.\nIf the person does not have a \"nextAvailableDate\", then the \"availableInDays\" property will be -1"
}
]
},
"docs": "
Permissions
HourlyProfile: Read
Person: Read"
},
{
"info": {
"name": "Updates a person to set and externalId that can be referenced by external systems.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Persons/:id/externalId",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The person ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a person to set and externalId that can be referenced by external systems."
},
{
"info": {
"name": "Gets all people in the given account filter by person ids.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Persons/_filter",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "NOTE: If there are more persons in the account than were returned, there will be a \"query-has-more\" header that will be set to true.
Permissions
HourlyProfile: Read
Person: Read
Finance: Read"
},
{
"info": {
"name": "Gets details for the given person",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Persons/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Person ID"
},
{
"name": "relativeDate",
"value": "2021-01-01",
"type": "query",
"description": "Optional paramater used to calculate date based properties. If not provided, it is set to today's date in UTC."
}
]
},
"docs": "
Permissions
Finance: Read
Person: Read
HourlyProfile: Read"
},
{
"info": {
"name": "Update a person in the given account. Each of the fields in the request body is optional - only fields that are present in the request will be updated.",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Persons/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Person ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Person: Write
HourlyProfile: Write
Finance: Read"
},
{
"info": {
"name": "Deactivate a person",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Persons/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Person ID"
}
]
},
"docs": "
Permissions
Person: Write
HourlyProfile: Write"
},
{
"info": {
"name": "Deactivate a person with optional deactivation details (reason, notes, would rehire).",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Persons/:id/deactivate",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Person ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Person: Write
HourlyProfile: Write"
},
{
"info": {
"name": "Get all allocations for the given person within the selected date range.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Persons/:id/allocations",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Person's ID"
},
{
"name": "relativeDate",
"value": "2021-01-01",
"type": "query",
"description": "Optional paramater used to calculate date based properties. If not provided, it is set to today's date in UTC."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start date to filter allocations from"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End date to filter allocations to"
},
{
"name": "roleId",
"value": "",
"type": "query",
"description": "Optional parameter to get allocations for a specific role"
},
{
"name": "projectState",
"value": "",
"type": "query",
"description": "Optional parameter for filtering results by project state."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Optional parameter Salaried role type to filter results by (Default to Operations)"
}
]
},
"docs": "
Permissions
Role: Read
HourlyRole: Read
Allocation: Read
HourlyAllocation: Read
Person: Read
HourlyProfile: Read"
},
{
"info": {
"name": "Get all projects that this person is allocated to, including past, present, and future allocations.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Persons/:id/projects",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Person ID"
},
{
"name": "relativeDate",
"value": "2021-01-01",
"type": "query",
"description": "Optional paramater used to calculate date based properties. If not provided, it is set to today's date in UTC."
},
{
"name": "projectState",
"value": "",
"type": "query",
"description": "Optional parameter for filtering results by project state."
}
]
},
"docs": "
Permissions
Person: Read
HourlyProfile: Read
Allocation: Read
HourlyAllocation: Read"
},
{
"info": {
"name": "Get all projects that any person in the given account has an active allocation for. That is, each allocation's start date is ≦ now and the end date is ≧ now.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Persons/current-projects",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "relativeDate",
"value": "2021-01-01",
"type": "query",
"description": "Optional paramater used to calculate date based properties. If not provided, it is set to today's date in UTC."
},
{
"name": "personIds",
"value": "",
"type": "query",
"description": "Optional paramater of comma delimited ids for filtering results based on the person IDs provided"
},
{
"name": "projectState",
"value": "",
"type": "query",
"description": "Optional parameter for filtering results by project state."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "(Optional)Salaried role type to filter results by (Defaults to All)"
}
]
},
"docs": "
Permissions
Person: Read
Allocation: Read"
},
{
"info": {
"name": "Get all projects that any person in the given account has an active allocation for. That is, each allocation's start date is ≦ now and the end date is ≧ now.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Persons/current-projects-hourly",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "relativeDate",
"value": "2021-01-01",
"type": "query",
"description": "Optional paramater used to calculate date based properties. If not provided, it is set to today's date in UTC."
},
{
"name": "personIds",
"value": "",
"type": "query",
"description": "Optional paramater of comma delimited ids for filtering results based on the person IDs provided"
},
{
"name": "projectState",
"value": "",
"type": "query",
"description": "Optional parameter for filtering results by project state."
}
]
},
"docs": "
Permissions
HourlyProfile: Read
HourlyAllocation: Read"
},
{
"info": {
"name": "Reactivate a person",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Persons/:id/restore",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Person ID"
}
]
},
"docs": "
Permissions
Person: Write
HourlyProfile: Write
Finance: Read"
}
]
},
{
"info": {
"name": "Phases",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets the list of phases in the given account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Phases",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
}
]
},
"docs": "
Permissions
Account: Read"
},
{
"info": {
"name": "Adds a new phase to the given account",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Phases",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "You must specify \"name\" for this endpoint.\n\n \nIf the \"includeOnNewProjects\" property is true, then the phase is included by default on new projects.\n\n \nAn account can have a maximum of 20 phases.
Permissions
Account: Write"
},
{
"info": {
"name": "Updates and re-orders the list of phases on an account",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Phases",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This endpoint will update the order of the phases in the account by the order that is sent in\nNOTE: This endpoint does not require all of the phases to be sent in.\nHOWEVER, if you do not pass in all of the phases on the account, the order may not come back in an expected order.
Permissions
Account: Write"
},
{
"info": {
"name": "Removes phases from the given account",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Phases",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Account: Write"
},
{
"info": {
"name": "Gets the phase by id in the given account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Phases/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Phase ID"
}
]
},
"docs": "
Permissions
Account: Read"
},
{
"info": {
"name": "Updates a single phase on an account",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Phases/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Phase ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Account: Write"
}
]
},
{
"info": {
"name": "ProjectFieldValue",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets all custom field values for the given project in the given account.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/project-field-values",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID the role belongs to"
},
{
"name": "includeEmpty",
"value": "",
"type": "query",
"description": "Returns fields with empty/unset value as well"
},
{
"name": "classification",
"value": "",
"type": "query",
"description": "Optional - for filtering result by classification: All or Experience\""
}
]
},
"docs": "
Permissions
Project: Read
Private: Read
Finance: Read"
},
{
"info": {
"name": "Set project's field values in the given account.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/project-field-values",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID the role belongs to"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "NOTE: It is mandatory that the fields with isRequired set to true be passed in as part of the request.\n\n\nExample: Say you have 2 project fields on an account \"Budget\" and \"City\" where isRequired is set to true on \"Budget\".\n\nFieldDefinition Example Response - GET ProjectFields (/api/v{version}/accounts/{id}/project-fields)\n[
{
\"id\": 1394,
\"name\": \"Budget\",
\"type\": \"Currency\",Validation\nOther: Free text. Max length: 2400\n\nAddress: Free text. Max length: 250\n\nProject Number: Free text. Max length: 250\n\nBudget: Currency. Starts with 0 to 15 digits of ```0-9``` then optionally followed by ```.``` with 0 to 2 digits of ```0-9```\n\nExternal ID: Free text. Max length: 250\n\nLabor Hours (Salaried): Positive integer. Must be greater than 0 and not exceed 2,147,483,647 (Int32.MaxValue). Decimals are not allowed. This is a syste"
},
{
"info": {
"name": "Clear project's field values by field IDs in the given account.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/project-field-values",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID the role belongs to"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Project: Write
Private: Read
Finance: Read"
},
{
"info": {
"name": "Update a single field's value(s) for project in the given account.",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/project-field-values/:fieldId",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID the role belongs to"
},
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "The field ID that the data can be updated"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validation
\nOther: Free text. Max length: 2400\n\nAddress: Free text. Max length: 250\n\nProject Number: Free text. Max length: 250\n\nBudget: Currency. Starts with 0 to 15 digits of ```0-9``` then optionally followed by ```.``` with 0 to 2 digits of ```0-9```\n\nExternal ID: Free text. Max length: 250\n\nLabor Hours (Salaried): Positive integer. Must be greater than 0 and not exceed 2,147,483,647 (Int32.MaxValue). Decimals are not allowed. This is a syste"
}
]
},
{
"info": {
"name": "ProjectFields",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets all project field definitions in the given account.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:id/project-fields",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The Account ID"
}
]
},
"docs": "
Permissions
Account: Read
Private: Read
Finance: Read"
},
{
"info": {
"name": "Adds or updates field definitions on the given account",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:id/project-fields",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The Account ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "If you pass in a FieldDefRequest object without an \"id\" this endpoint will add a new one to the account if the name isn't reserved or in use.\n\nIf you pass in a FieldDefRequest object with an \"id\" this endpoint will update an existing one that matches the id.\n\nTo add a value or multiple values to a selection list you must pass an array of \"definedValues\" that contain objects with a \"definedValue\" property of the value you want to add.\n\nTo update a value or multiple values in a selection list you "
},
{
"info": {
"name": "Removes project field definitions in the given account.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:id/project-fields",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The Account ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Account: Write"
},
{
"info": {
"name": "Update the display order of project field definitions for the given account.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:id/project-fields/_reorder",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The account ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Accepts an array of objects containing fieldId and displayOrder.\n\nSystem fields cannot be reordered and should not be included in the request.\n\nAll custom fields should be included with their new display order values.
Permissions
Account: Write"
}
]
},
{
"info": {
"name": "ProjectGroupings",
"type": "folder"
},
"items": [
{
"info": {
"name": "Set grouping to the project in the given account",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/groupings",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Project: Write"
},
{
"info": {
"name": "Update grouping to the project in the given account",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/groupings",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Project: Write"
},
{
"info": {
"name": "Removes grouping from the project in the given account",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/groupings/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The grouping ID for project"
}
]
},
"docs": "
Permissions
Project: Write"
}
]
},
{
"info": {
"name": "ProjectNotes",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets all notes on the given account's project.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/notes",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID the note belongs to"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Offset for pagination"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of results per page"
}
]
},
"docs": "
Permissions
Project: Read
Private: Read"
},
{
"info": {
"name": "Adds a note on the given account's project.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/notes",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID to add the note to"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "When trying to create a private note you must have permissions to manage private values in the account. \n\nWhen trying to mention a user, you must provide their userID in the following pattern [[mention:userID#123]].
Permissions
Project: Read
Private: Write"
},
{
"info": {
"name": "Gets a note on the given account's project by id.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/notes/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID the note belongs to"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the note"
}
]
},
"docs": "
Permissions
Project: Read
Private: Read"
},
{
"info": {
"name": "Updates a note on the given account's project.",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/notes/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID the note is on"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the note to update"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "When trying to update a note's privacy you must have permissions to manage private values in the account.\n\nOnly the creator of a note can edit it.\n\nWhen trying to mention a user, you must provide their userID in the following pattern [[mention:userID#123]].
Permissions
Project: Read
Private: Write"
},
{
"info": {
"name": "Deletes a note from the given account's project.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/notes/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID the note is on"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the note to update"
}
]
},
"docs": "Only the creator or an account admin can delete it.
Permissions
Project: Read
Account: Write"
}
]
},
{
"info": {
"name": "ProjectRoleCategories",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets categories on the given account's project.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/role-categories",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID to get categories from"
}
]
},
"docs": "
Permissions
Role: Read
HourlyRole: Read"
},
{
"info": {
"name": "Adds a category on the given account's project.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/role-categories",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID to add the category to"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "You must be able to manage salaried OR hourly roles.
Permissions
Role: Write
HourlyRole: Write"
},
{
"info": {
"name": "Bulk update categories on the given account's project.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/role-categories",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID to add the category to"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "NOTE: The category name must not be greater than 100 characters.
Permissions
Role: Write
HourlyRole: Write"
},
{
"info": {
"name": "Removes categories on the given account's project.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/role-categories",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID to delete the categories from"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "You must be able to manage salaried OR hourly roles.
Permissions
Role: Write
HourlyRole: Write"
}
]
},
{
"info": {
"name": "ProjectRoles",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets all roles in the given account's project.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/roles",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID the role belongs to"
},
{
"name": "relativeDate",
"value": "2021-01-01",
"type": "query",
"description": "Optional paramater used to calculate date based properties. If not provided, it is set to today's date in UTC."
},
{
"name": "roleState",
"value": "",
"type": "query",
"description": "(Optional) Filters the result by the state of the role dates: Current, Upcoming, Past, or All"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "(Optional)Salaried role type to filter results by (Defaults to Operations)"
}
]
},
"docs": "
Permissions
Role: Read
Finance: Read"
},
{
"info": {
"name": "Add role for the given account's project.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/roles",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID the role belongs to"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Role: Write
Finance: Read"
},
{
"info": {
"name": "Bulk add roles for the given account's project.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/roles/bulk",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID the role belongs to"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Role: Write
Finance: Read"
},
{
"info": {
"name": "Remove role by IDs in the given account's project.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/roles/bulk",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID that the role belongs to"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Role: Write"
},
{
"info": {
"name": "Get role by ID in the given account's project.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/roles/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID that the role belongs to"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The role ID"
}
]
},
"docs": "
Permissions
Role: Read
Finance: Read"
},
{
"info": {
"name": "Update role by ID in the given account's project.\nThe task ID is required when updating a task role.\nThe task ID cannot be updated.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/roles/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID that the role belongs to"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The role ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Role: Write
Finance: Read"
},
{
"info": {
"name": "Remove role by ID in the given account's project.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/roles/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID that the role belongs to"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The role ID"
}
]
},
"docs": "
Permissions
Role: Write"
},
{
"info": {
"name": "Updates a role to set an external ID that can be referenced by external systems.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/roles/:id/externalId",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Role ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a role to set an external ID that can be referenced by external systems."
}
]
},
{
"info": {
"name": "ProjectTasks",
"type": "folder"
},
"items": [
{
"info": {
"name": "Bulk add tasks for the given account's project.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/tasks",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID the task belongs to"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Project: Read
Person: Read
Role: Write
Allocation: Read"
},
{
"info": {
"name": "Bulk update tasks for the given account's project.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/tasks",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID the task belongs to"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Project: Read
Person: Read
Role: Write"
},
{
"info": {
"name": "Add a role to a task for the given account's project.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/tasks/:id/roles",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID the task belongs to"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The task ID the task belongs to"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Project: Read
Person: Read
Role: Write
Allocation: Read
Finance: Read"
},
{
"info": {
"name": "Bulk add roles to a task for the given account's project.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/tasks/:id/roles/bulk",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID the task belongs to"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The task ID the task belongs to"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Project: Read
Person: Read
Role: Write
Allocation: Read
Finance: Read"
},
{
"info": {
"name": "Update a task role by ID in the given account's project.",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/tasks/:taskId/roles/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID"
},
{
"name": "taskId",
"value": "",
"type": "path",
"description": "The task ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The role ID the task role belongs to"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Project: Read
Person: Read
Role: Write
Allocation: Read
Finance: Read"
},
{
"info": {
"name": "Remove task role by ID in the given account's project.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/tasks/:taskId/roles/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID that the task belongs to"
},
{
"name": "taskId",
"value": "",
"type": "path",
"description": "The task ID that the role belongs to"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The role ID"
}
]
},
"docs": "
Permissions
Project: Read
Person: Read
Role: Write
Allocation: Read"
},
{
"info": {
"name": "Allocates a person to a task role on the given account and project",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/tasks/:taskId/roles/:id/allocations",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID"
},
{
"name": "taskId",
"value": "",
"type": "path",
"description": "The task ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The role ID the task role belongs to"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "A person cannot be allocated entirely inside a period of unavailability and cannot be allocated outside of their employment dates.\n\nFor allocations that overlap a period of unavailability, the API will truncate or not set the date range that the person is unavailable.\n\nExamples: Unavailable from 2020-01-11 to 2020-01-25, Allocation date from 2020-01-20 to 2020-03-31, will alocate the person from 2020-01-26 to 2020-03-31\n\nUnavailable from 2020-01-11 to 2020-01-25, Allocation date from 2020-01-01 "
},
{
"info": {
"name": "Removes a person's allocation on a task role on the given account and project",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/tasks/:taskId/roles/:id/allocations",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID"
},
{
"name": "taskId",
"value": "",
"type": "path",
"description": "The task ID that the role belongs to"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The role ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "The request must contain the person id, start and end date to ensure that the role and allocation is correct and hasn't been modified before trying to delete it.
Permissions
Project: Read
Person: Read
Role: Read
Allocation: Write"
},
{
"info": {
"name": "Bulk allocates people to task roles on the given account and project task",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/tasks/:taskId/roles/allocations/bulk",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID"
},
{
"name": "taskId",
"value": "",
"type": "path",
"description": "The task ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "A person cannot be allocated entirely inside a period of unavailability and cannot be allocated outside of their employment dates.\n\nFor allocations that overlap a period of unavailability, the API will truncate or not set the date range that the person is unavailable.\n\nExamples: Unavailable from 2020-01-11 to 2020-01-25, Allocation date from 2020-01-20 to 2020-03-31, will alocate the person from 2020-01-26 to 2020-03-31\n\nUnavailable from 2020-01-11 to 2020-01-25, Allocation date from 2020-01-01 "
},
{
"info": {
"name": "Remove task by ID in the given account's project.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/tasks/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID that the role belongs to"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The task ID"
}
]
},
"docs": "
Permissions
Project: Read
Person: Read
Role: Write"
},
{
"info": {
"name": "Add tasks and roles for the given account's project using task template definition.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/tasks/by-templates",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID the tasks belongs to"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Project: Read
Person: Read
Role: Write
Allocation: Read
Finance: Read"
}
]
},
{
"info": {
"name": "ProjectWorkforceSpendReports",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get the workforce spend reports (salaried only) on hours with breakdown, grouped by role name, period, then by assignee, given the project ID",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/workforce-spend-reports/hours-breakdown",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID the workforce belongs to"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "NOTE: If there are more workforce spend reports in the project than were returned, there will be a \"query-has-more\" header that will be set to true.
Permissions
Project: Read
Person: Read
Role: Read"
},
{
"info": {
"name": "Get the workforce spend reports (salaried only) on hours with overview on elapsed, remainder, grouped by role name, and assignee, given the project ID",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/workforce-spend-reports/hours-overview",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The project ID the workforce belongs to"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "NOTE: If there are more workforce spend reports in the project than were returned, there will be a \"query-has-more\" header that will be set to true.
Permissions
Project: Read
Person: Read
Role: Read"
}
]
},
{
"info": {
"name": "Projects",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets all projects in the given account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Projects",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "relativeDate",
"value": "2021-01-01",
"type": "query",
"description": "Optional paramater used to calculate date based properties. If not provided, it is set to today's date in UTC."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Offset for pagination"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of results in this page"
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Name filter that affects whether or not to return projects back with/without the name contains partial match (Default: Empty)"
},
{
"name": "issues",
"value": "",
"type": "query",
"description": "State filter that affects whether or not to return projects back with/without or any issues (Default: All)"
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "Optional comma delimited list of project IDs to filter the result on"
},
{
"name": "projectState",
"value": "",
"type": "query",
"description": "Optional comma delimited list for filtering results by project state."
},
{
"name": "includeProjectNumber",
"value": "",
"type": "query",
"description": "Whether to include the Project Number field in the response (Default: false)"
}
]
},
"docs": "NOTE: If there are more projects in the account than were returned, there will be a \"query-has-more\" header that will be set to true.
Permissions
Project: Read
Role: Read
HourlyRole: Read"
},
{
"info": {
"name": "Add a project to the given account",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Projects",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "If you add a project with a type of Awarded, it will be created with a state based on the date.\n\nIf you add a project with a type of Opportunity, it will be created with a state of Pursuit.\n\nThe \"winPercent\" is associated with an Opportunity, you can create an Opportunity with a winPercent but not for an Awarded project.\nNOTE: Opportunities do not count towards allocation statistics so, any roles and allocations set on the project will not cause conflicts, issue"
},
{
"info": {
"name": "Gets all projects in the given account filter by project ids.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Projects/_filter",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "NOTE: If there are more projects in the account than were returned, there will be a \"query-has-more\" header that will be set to true.
Permissions
Project: Read
Role: Read
HourlyRole: Read"
},
{
"info": {
"name": "Updates a project to set and externalId that can be referenced by external systems.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Projects/:id/externalId",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Project ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a project to set and externalId that can be referenced by external systems."
},
{
"info": {
"name": "Gets details for the given project",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Projects/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Project ID"
},
{
"name": "relativeDate",
"value": "2021-01-01",
"type": "query",
"description": "Optional paramater used to calculate date based properties. If not provided, it is set to today's date in UTC."
}
]
},
"docs": "
Permissions
Project: Read
Role: Read
HourlyRole: Read"
},
{
"info": {
"name": "Update a project in the given account. Each of the fields in the request body is optional - only fields that are present in the request will be updated.\nWhen changing the start or end dates for a project, you can customize how the start and end dates for roles and phases will change in response. See the Model below for details.\nNote that roles or phases whose start and end dates change such that the start date is after the end date will be automatically deleted from the project.",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Projects/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Project ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "To update a project's dates you need the ProjectDates permission, which is separate from the Project Write permission that is required to update other project details. \nThis is because changing project dates can have a significant impact on any associated roles and phases, and therefore only users with the ProjectDates permission should be allowed to make those changes.\n\n\nIf the \"shiftDates\" property is true and you specify a changed project start or end date in this request,\nth"
},
{
"info": {
"name": "Delete a project",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/Projects/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Project ID"
}
]
},
"docs": "
Permissions
Project: Write"
}
]
},
{
"info": {
"name": "ProjectsPhases",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets all phases on the given project",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/phases",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID"
}
]
},
"docs": "
Permissions
Project: Read"
},
{
"info": {
"name": "Adds a phase to the given project",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/phases",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "You must specify \"id\", \"startDate\" and \"endDate\" of any phase for this endpoint.
Permissions
Project: Write"
},
{
"info": {
"name": "Deletes phases from the given project",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/phases",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Deletes phases from the given project"
},
{
"info": {
"name": "Adds phases to the given project",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/phases/bulk",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "You must specify \"id\", \"startDate\" and \"endDate\" of any phase for this endpoint.
Permissions
Project: Write"
},
{
"info": {
"name": "Updates multiple phases on the given project",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/phases/bulk",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This endpoint will only update the fields that are present in the request.\n\nYou must specify \"id\", \"startDate\" and/or \"endDate\" of the phases for this endpoint.\n\n \nIf the \"shiftDates\" property is true and you specify a changed phase start or end date in this request,\nthen the phase's start and end dates will be adjusted by the same amount.\nIf this property is set to true, then you must only send EITHER startDate OR endDate - only startDate is considered when both date"
},
{
"info": {
"name": "Updates a phase on the given project",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/projects/:projectId/phases/:phaseId",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID"
},
{
"name": "phaseId",
"value": "",
"type": "path",
"description": "The Phase ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This endpoint will only update the fields that are present in the request.\n\nYou must specify \"startDate\" and/or \"endDate\" for this endpoint.\n\n \nIf the \"shiftDates\" property is true and you specify a changed phase start or end date in this request,\nthen the phase's start and end dates will be adjusted by the same amount.\n\nIf this property is set to true, then you must only send EITHER startDate OR endDate - only startDate is considered when both dates are set.\n
Permissions
Account: Read
Finance: Read
Role: Read"
},
{
"info": {
"name": "Add/Update role name(s) in the account",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/role-names",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The account ID"
},
{
"name": "alphabetize",
"value": "",
"type": "query",
"description": "Optional flag to set whether role names should be alphabetically ordered by the caller"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "If \"alphabetize\" parameter flag is true, the role names should be alphabetically ordered by caller, otherwise in the order of the request.\n\nTo add or update role names you must have permissions to manage account properties.
Permissions
Account: Write
Role: Write"
},
{
"info": {
"name": "Remove role name(s) by ID in the account",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/role-names",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The account ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "To remove role names you must have permissions to manage account properties.\nNOTE: The account must contain at least 1 role name.
Permissions
Account: Write
Role: Write"
}
]
},
{
"info": {
"name": "ServiceAccounts",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets service accounts in the given account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/service-accounts",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "(Optional) Filters the result to contain accounts that match the ids passed in."
}
]
},
"docs": "
Permissions
Account: Read"
},
{
"info": {
"name": "Creates a service account in the given account",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/service-accounts",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This endpoint will generate a unique login and password in the response.\n\nThere is no way to retrieve the password again after the account is created.\n\nThis is a limit of 10 service accounts on a single account.
Permissions
Account: Write"
},
{
"info": {
"name": "Updates a service account in the given account",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/service-accounts/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Service Account ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "You must specify both \"name\" and \"group\" for this endpoint.
Permissions
Account: Write"
},
{
"info": {
"name": "Deactivates a service account in the given account",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/service-accounts/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Service Account ID"
}
]
},
"docs": "Deactivates the account preventing it from being able to log in and make API calls.
Permissions
Account: Write"
},
{
"info": {
"name": "Generates a new password for a service account in the given account",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/service-accounts/:id/reset-password",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Service Account ID"
}
]
},
"docs": "This endpoint will generate a new password in the response.\n\nThere is no way to retrieve the password again. A new password will need to be generated if you lose it.
Permissions
Account: Write"
}
]
},
{
"info": {
"name": "SharedFilters",
"type": "folder"
},
"items": [
{
"info": {
"name": "Delete a shared filter from the given account",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/shared-filters/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "Id of the filter to remove"
}
]
},
"docs": "
Permissions
Account: Write"
}
]
},
{
"info": {
"name": "UserFilters",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets user's saved filters in the given account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/my-filters",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Offset for pagination"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of results in this page"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "The filter type to return in the result"
},
{
"name": "name",
"value": "",
"type": "query",
"description": "The filter name by partial match to return in the result"
}
]
},
"docs": "
Permissions
Account: Read"
},
{
"info": {
"name": "Add a filter for the user in the given account.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/my-filters",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Account: Read"
},
{
"info": {
"name": "Get user's saved filter for the given account by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/my-filters/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The filter's ID"
}
]
},
"docs": "
Permissions
Account: Read"
},
{
"info": {
"name": "Update user's saved filter from the given account",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/my-filters/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "Id of the filter to remove"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Permissions
Account: Read"
},
{
"info": {
"name": "Delete user's saved filter from the given account",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/my-filters/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "Id of the filter to remove"
}
]
},
"docs": "
Permissions
Account: Read"
}
]
},
{
"info": {
"name": "Users",
"type": "folder"
},
"items": [
{
"info": {
"name": "Modify system user's permission group.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/Users/:id/membership",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Id of the user to remove"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify system user's permission group."
}
]
}
],
"bundled": true
}