vCita Staff Business Role API
The Staff Business Role API from vCita — 2 operation(s) for staff business role.
The Staff Business Role API from vCita — 2 operation(s) for staff business role.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/vcita:vcita-staff-business-role-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Platform_administration Staff Business Role API
description: Unified OpenAPI specification for platform_administration domain
version: '3.0'
x-generated:
sourceFiles:
- directory.json
- license.json
- operator-portal.json
- legacy_v2_todo.json
- legacy_v1_platform.json
- legacy_v2_settings_businesses.json
- business.json
- staff.json
- staff_member.json
- oauth.json
- online_profiles.json
- partners-api.json
- staff.json
- access_control.json
- accounts.json
pathNormalizations:
- file: license.json
basePath: /v3
transformations:
- original: /license/offerings
normalized: /v3/license/offerings
basePath: /v3
- original: /license/offerings/{uid}
normalized: /v3/license/offerings/{uid}
basePath: /v3
- original: /license/directory_offerings
normalized: /v3/license/directory_offerings
basePath: /v3
- original: /license/directory_offerings/{uid}
normalized: /v3/license/directory_offerings/{uid}
basePath: /v3
- original: /license/bundled_offerings
normalized: /v3/license/bundled_offerings
basePath: /v3
- original: /license/bundled_offerings/bulk
normalized: /v3/license/bundled_offerings/bulk
basePath: /v3
- original: /license/bundled_offerings/{uid}
normalized: /v3/license/bundled_offerings/{uid}
basePath: /v3
- original: /license/subscriptions
normalized: /v3/license/subscriptions
basePath: /v3
- original: /license/subscriptions/bulk
normalized: /v3/license/subscriptions/bulk
basePath: /v3
- original: /license/subscriptions/{uid}
normalized: /v3/license/subscriptions/{uid}
basePath: /v3
- original: /license/business_carts
normalized: /v3/license/business_carts
basePath: /v3
- original: /license/business_carts/{uid}
normalized: /v3/license/business_carts/{uid}
basePath: /v3
- original: /license/skus
normalized: /v3/license/skus
basePath: /v3
- original: /license/features_packages
normalized: /v3/license/features_packages
basePath: /v3
- original: /license/features
normalized: /v3/license/features
basePath: /v3
- original: /license/features/{uid}
normalized: /v3/license/features/{uid}
basePath: /v3
- original: /license/features_packages/{id}
normalized: /v3/license/features_packages/{id}
basePath: /v3
- original: /license/features_packages/add_feature
normalized: /v3/license/features_packages/add_feature
basePath: /v3
- original: /license/quota_consumptions
normalized: /v3/license/quota_consumptions
basePath: /v3
- original: /license/quota_balances
normalized: /v3/license/quota_balances
basePath: /v3
- file: operator-portal.json
basePath: /api/operator_api/v1
transformations:
- original: /packages
normalized: /api/operator_api/v1/packages
basePath: /api/operator_api/v1
- original: /packages/{id}
normalized: /api/operator_api/v1/packages/{id}
basePath: /api/operator_api/v1
- original: /packages/add_feature
normalized: /api/operator_api/v1/packages/add_feature
basePath: /api/operator_api/v1
- original: /features
normalized: /api/operator_api/v1/features
basePath: /api/operator_api/v1
- original: /features/{id}
normalized: /api/operator_api/v1/features/{id}
basePath: /api/operator_api/v1
- file: legacy_v1_platform.json
basePath: /platform/v1
transformations:
- original: /businesses
normalized: /platform/v1/businesses
basePath: /platform/v1
- original: /businesses/validate_login
normalized: /platform/v1/businesses/validate_login
basePath: /platform/v1
- original: /businesses/verify_audience_claim
normalized: /platform/v1/businesses/verify_audience_claim
basePath: /platform/v1
- original: /businesses/{business_uid}
normalized: /platform/v1/businesses/{business_uid}
basePath: /platform/v1
- original: /directory/branding
normalized: /platform/v1/directory/branding
basePath: /platform/v1
- original: /tokens
normalized: /platform/v1/tokens
basePath: /platform/v1
- original: /tokens/revoke
normalized: /platform/v1/tokens/revoke
basePath: /platform/v1
- original: /webhook/subscribe
normalized: /platform/v1/webhook/subscribe
basePath: /platform/v1
- original: /webhook/unsubscribe
normalized: /platform/v1/webhook/unsubscribe
basePath: /platform/v1
- original: /webhooks
normalized: /platform/v1/webhooks
basePath: /platform/v1
- original: /businesses/{business_uid}/features
normalized: /platform/v1/businesses/{business_uid}/features
basePath: /platform/v1
- original: /businesses/{business_uid}/purchased_items
normalized: /platform/v1/businesses/{business_uid}/purchased_items
basePath: /platform/v1
- original: /businesses/{business_uid}/recurly_data
normalized: /platform/v1/businesses/{business_uid}/recurly_data
basePath: /platform/v1
- original: /businesses/{business_uid}/staffs
normalized: /platform/v1/businesses/{business_uid}/staffs
basePath: /platform/v1
- original: /businesses/{business_uid}/staffs/{staff_uid}
normalized: /platform/v1/businesses/{business_uid}/staffs/{staff_uid}
basePath: /platform/v1
- original: /businesses/{business_uid}/staffs/{staff_uid}/sessions
normalized: /platform/v1/businesses/{business_uid}/staffs/{staff_uid}/sessions
basePath: /platform/v1
- original: /businesses/{business_uid}/wizards
normalized: /platform/v1/businesses/{business_uid}/wizards
basePath: /platform/v1
- original: /businesses/{business_uid}/wizards/{wizard_name}
normalized: /platform/v1/businesses/{business_uid}/wizards/{wizard_name}
basePath: /platform/v1
- original: /scheduling/staff
normalized: /platform/v1/scheduling/staff
basePath: /platform/v1
- original: /scheduling/staff/{staff_uid}
normalized: /platform/v1/scheduling/staff/{staff_uid}
basePath: /platform/v1
- original: /business/jobber/flows
normalized: /platform/v1/business/jobber/flows
basePath: /platform/v1
- original: /business/jobber/executions
normalized: /platform/v1/business/jobber/executions
basePath: /platform/v1
- file: staff.json
basePath: /business/staffs
transformations:
- original: /v1/daily_staff_sign_ins
normalized: /business/staffs/v1/daily_staff_sign_ins
basePath: /business/staffs
- original: /v1/staffs/{uid}
normalized: /business/staffs/v1/staffs/{uid}
basePath: /business/staffs
- file: oauth.json
basePath: /oauth
transformations:
- original: /token
normalized: /oauth/token
basePath: /oauth
- original: /userinfo
normalized: /oauth/userinfo
basePath: /oauth
- file: online_profiles.json
basePath: /v3/business_administration
transformations:
- original: /online_profiles/{business_uid}
normalized: /v3/business_administration/online_profiles/{business_uid}
basePath: /v3/business_administration
- original: /online_profiles
normalized: /v3/business_administration/online_profiles
basePath: /v3/business_administration
- original: /online_profiles/{uid}
normalized: /v3/business_administration/online_profiles/{uid}
basePath: /v3/business_administration
- file: accounts.json
basePath: /business/accounts
transformations:
- original: /v1/attributes
normalized: /business/accounts/v1/attributes
basePath: /business/accounts
- original: /v1/branding
normalized: /business/accounts/v1/branding
basePath: /business/accounts
- original: /v1/identities
normalized: /business/accounts/v1/identities
basePath: /business/accounts
- original: /v1/usage/last_3_months_activity
normalized: /business/accounts/v1/usage/last_3_months_activity
basePath: /business/accounts
pathConflicts: []
componentConflicts:
- type: schema
name: ErrorResponse
resolution: Renamed to ErrorResponse_license
files:
- merged
- license.json
- type: schema
name: ErrorResponse
resolution: Renamed to ErrorResponse_operator-portal
files:
- merged
- operator-portal.json
- type: schema
name: Paging
resolution: Renamed to Paging_business
files:
- merged
- business.json
- type: schema
name: ErrorResponse
resolution: Renamed to ErrorResponse_online_profiles
files:
- merged
- online_profiles.json
- type: schema
name: ErrorResponse
resolution: Renamed to ErrorResponse_staff
files:
- merged
- staff.json
totalPaths: 85
totalComponents: 54
servers:
- url: https://api.vcita.biz
description: Unified API Gateway server
tags:
- name: Staff Business Role
paths:
/v3/access_control/staff_business_roles:
get:
summary: Get all StaffBusinessRoles
description: 'Get a list of StaffBusinessRoles
Available for **Staff Tokens**'
parameters:
- name: staff_uid
required: false
in: query
description: The unique identifier (UID) of the business account
schema:
type: string
- name: business_role_uid
required: false
in: query
description: The unique identifier (UID) of the business account
schema:
type: string
- name: page
required: false
in: query
description: Page number of results.
schema:
minimum: 1
maximum: 10000
default: 1
type: number
- name: per_page
required: false
in: query
description: 'How many items to return per page. Max: 100'
schema:
minimum: 1
maximum: 100
default: 25
type: number
- description: 'Sort by fields. Example: sort=created_at:asc,updated_at:desc'
name: sort
required: false
in: query
schema:
default: updated_at:desc
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
allOf:
- type: object
properties:
success:
type: boolean
description: Indicates whether the API request was successful (true) or failed (false).
data:
type: object
description: 'The response payload. Present on successful responses (success: true).'
error:
type: string
description: Error message for simple error responses. Used in some legacy endpoints.
errors:
type: array
description: 'Array of error objects for detailed error responses. Present on error responses (success: false).'
items:
type: object
properties:
code:
type: string
description: Machine-readable error code (e.g., 'already_exists', 'invalid', 'not_found').
message:
type: string
description: Human-readable error message.
field:
type: string
description: The field that caused the error (for validation errors).
required:
- code
- message
required:
- success
description: Generic wrapper object for API responses. Success responses contain 'data', while error responses contain 'errors' array or 'error' string.
- properties:
data:
$ref: '#/components/schemas/StaffBusinessRolesList'
tags:
- Staff Business Role
security:
- Bearer: []
operationId: getV3AccessControlStaffBusinessRoles
x-operation-id-source: derived
post:
summary: Create a StaffBusinessRole
description: 'Create a new StaffBusinessRole for a staff
Available for **Staff Tokens**'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
staff_uid:
type: string
description: The unique identifier (UID) of the staff member
business_role_uid:
type: string
description: The unique identifier (UID) of the associated StaffBusinessRole
required:
- staff_uid
- business_role_uid
example:
staff_uid: d290f1ee-6c54-4b01-90e6-d701748f0851
business_role_uid: d290f1ee-6c54-4b01-90e6-d701748f0851
responses:
'200':
description: ''
content:
application/json:
schema:
allOf:
- type: object
properties:
success:
type: boolean
description: Indicates whether the API request was successful (true) or failed (false).
data:
type: object
description: 'The response payload. Present on successful responses (success: true).'
error:
type: string
description: Error message for simple error responses. Used in some legacy endpoints.
errors:
type: array
description: 'Array of error objects for detailed error responses. Present on error responses (success: false).'
items:
type: object
properties:
code:
type: string
description: Machine-readable error code (e.g., 'already_exists', 'invalid', 'not_found').
message:
type: string
description: Human-readable error message.
field:
type: string
description: The field that caused the error (for validation errors).
required:
- code
- message
required:
- success
description: Generic wrapper object for API responses. Success responses contain 'data', while error responses contain 'errors' array or 'error' string.
- properties:
data:
type: object
properties:
staff_uid:
type: string
description: The unique identifier (UID) of the staff member
business_role_uid:
type: string
description: A unique identifier (UID) of the associated BusinessRole
created_at:
type: string
description: Date the StaffBusinessRole was created
updated_at:
type: string
description: Date the StaffBuinsessRole was last updated
required:
- staff_uid
- business_role_uid
- created_at
- updated_at
example:
staff_uid: d290f1ee-6c54-4b01-90e6-d701748f0851
business_role_uid: d290f1ee-6c54-4b01-90e6-d701748f0851
created_at: '2021-07-20T14:00:00.000Z'
updated_at: '2021-07-20T14:00:00.000Z'
description: A StaffBusinessRole is an assignment of a BusinessRole to a staff member, defining their permissions within a business account. For example, admin, manager etc.
tags:
- Staff Business Role
security:
- Bearer: []
operationId: postV3AccessControlStaffBusinessRoles
x-operation-id-source: derived
/v3/access_control/staff_business_roles/{staff_uid}:
get:
summary: Retrieve a StaffBusinessRole
description: 'Retrieve a StaffBusinessRole based on the unique identifier of staff_uid (staff_uid)
Available for **Staff Tokens**'
parameters:
- name: staff_uid
required: true
in: path
description: Unique identifier of the staff member assigned to this BusinessRole
schema:
type: string
example: 94ca2054-3bb0-4788-8e9e-ee2442975cdd
responses:
'200':
description: ''
content:
application/json:
schema:
allOf:
- type: object
properties:
success:
type: boolean
description: Indicates whether the API request was successful (true) or failed (false).
data:
type: object
description: 'The response payload. Present on successful responses (success: true).'
error:
type: string
description: Error message for simple error responses. Used in some legacy endpoints.
errors:
type: array
description: 'Array of error objects for detailed error responses. Present on error responses (success: false).'
items:
type: object
properties:
code:
type: string
description: Machine-readable error code (e.g., 'already_exists', 'invalid', 'not_found').
message:
type: string
description: Human-readable error message.
field:
type: string
description: The field that caused the error (for validation errors).
required:
- code
- message
required:
- success
description: Generic wrapper object for API responses. Success responses contain 'data', while error responses contain 'errors' array or 'error' string.
- properties:
data:
type: object
properties:
staff_uid:
type: string
description: The unique identifier (UID) of the staff member
business_role_uid:
type: string
description: A unique identifier (UID) of the associated BusinessRole
created_at:
type: string
description: Date the StaffBusinessRole was created
updated_at:
type: string
description: Date the StaffBuinsessRole was last updated
required:
- staff_uid
- business_role_uid
- created_at
- updated_at
example:
staff_uid: d290f1ee-6c54-4b01-90e6-d701748f0851
business_role_uid: d290f1ee-6c54-4b01-90e6-d701748f0851
created_at: '2021-07-20T14:00:00.000Z'
updated_at: '2021-07-20T14:00:00.000Z'
description: A StaffBusinessRole is an assignment of a BusinessRole to a staff member, defining their permissions within a business account. For example, admin, manager etc.
tags:
- Staff Business Role
security:
- Bearer: []
operationId: getV3AccessControlStaffBusinessRolesByStaffUid
x-operation-id-source: derived
put:
summary: Update a StaffBusinessRole
description: 'Update the business role for a staff member. **All overrides will be removed** and user will need to reapply them if the old role is reassigned. You can not change the role of the business owner.
Available for **Staff Tokens**'
parameters:
- name: staff_uid
required: true
in: path
description: Unique identifier of the StaffBusinessRole
schema:
type: string
example: 94ca2054-3bb0-4788-8e9e-ee2442975cdd
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
business_role_uid:
type: string
description: The unique identifier (UID) of the BusinessRole assigned
required:
- staff_uid
- business_role_uid
example:
business_role_uid: d290f1ee-6c54-4b01-90e6-d701748f0851
responses:
'200':
description: ''
content:
application/json:
schema:
allOf:
- type: object
properties:
success:
type: boolean
description: Indicates whether the API request was successful (true) or failed (false).
data:
type: object
description: 'The response payload. Present on successful responses (success: true).'
error:
type: string
description: Error message for simple error responses. Used in some legacy endpoints.
errors:
type: array
description: 'Array of error objects for detailed error responses. Present on error responses (success: false).'
items:
type: object
properties:
code:
type: string
description: Machine-readable error code (e.g., 'already_exists', 'invalid', 'not_found').
message:
type: string
description: Human-readable error message.
field:
type: string
description: The field that caused the error (for validation errors).
required:
- code
- message
required:
- success
description: Generic wrapper object for API responses. Success responses contain 'data', while error responses contain 'errors' array or 'error' string.
- properties:
data:
type: object
properties:
staff_uid:
type: string
description: The unique identifier (UID) of the staff member
business_role_uid:
type: string
description: A unique identifier (UID) of the associated BusinessRole
created_at:
type: string
description: Date the StaffBusinessRole was created
updated_at:
type: string
description: Date the StaffBuinsessRole was last updated
required:
- staff_uid
- business_role_uid
- created_at
- updated_at
example:
staff_uid: d290f1ee-6c54-4b01-90e6-d701748f0851
business_role_uid: d290f1ee-6c54-4b01-90e6-d701748f0851
created_at: '2021-07-20T14:00:00.000Z'
updated_at: '2021-07-20T14:00:00.000Z'
description: A StaffBusinessRole is an assignment of a BusinessRole to a staff member, defining their permissions within a business account. For example, admin, manager etc.
tags:
- Staff Business Role
security:
- Bearer: []
operationId: putV3AccessControlStaffBusinessRolesByStaffUid
x-operation-id-source: derived
components:
schemas:
StaffBusinessRolesList:
type: object
properties:
staff_business_roles:
description: List of StaffBusinessRoles
type: array
items:
type: object
properties:
staff_uid:
type: string
description: The unique identifier (UID) of the staff member
business_role_uid:
type: string
description: A unique identifier (UID) of the associated BusinessRole
created_at:
type: string
description: Date the StaffBusinessRole was created
updated_at:
type: string
description: Date the StaffBuinsessRole was last updated
required:
- staff_uid
- business_role_uid
- created_at
- updated_at
example:
staff_uid: d290f1ee-6c54-4b01-90e6-d701748f0851
business_role_uid: d290f1ee-6c54-4b01-90e6-d701748f0851
created_at: '2021-07-20T14:00:00.000Z'
updated_at: '2021-07-20T14:00:00.000Z'
description: A StaffBusinessRole is an assignment of a BusinessRole to a staff member, defining their permissions within a business account. For example, admin, manager etc.
securitySchemes:
Bearer:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {app_token}'''
Business:
type: http
scheme: bearer
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {token}'''
Directory:
type: http
scheme: bearer
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {app_token}'''
x-provenance:
method: searched
source: https://developers.intandem.tech:443/reference
harvested: '2026-11-15'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://developers.intandem.tech/reference/account-creation-1.md
- https://developers.intandem.tech/reference/account-manipulation.md
- https://developers.intandem.tech/reference/addfeaturetofeaturespackages.md
- https://developers.intandem.tech/reference/addremove-staff.md
- https://developers.intandem.tech/reference/business-info.md
- https://developers.intandem.tech/reference/close-an-account.md
- https://developers.intandem.tech/reference/createfeaturespackage.md
- https://developers.intandem.tech/reference/createlicensefeature.md
- https://developers.intandem.tech/reference/createonlineprofile.md
- https://developers.intandem.tech/reference/createquotaconsumption.md
- https://developers.intandem.tech/reference/delete_api-operator-api-v1-features-id.md
- https://developers.intandem.tech/reference/delete_api-operator-api-v1-packages-id.md
- https://developers.intandem.tech/reference/delete_business-accounts-v1-identities.md
- https://developers.intandem.tech/reference/delete_platform-v1-businesses-business-uid-staffs-staff-uid-sessions.md
- https://developers.intandem.tech/reference/delete_platform-v1-businesses-business-uid-staffs-staff-uid.md
- https://developers.intandem.tech/reference/delete_v3-access-control-business-roles-uid.md
- https://developers.intandem.tech/reference/delete_v3-access-control-staff-permission-overrides-lists-staff-uid.md
- https://developers.intandem.tech/reference/delete_v3-license-bundled-offerings-uid.md
- https://developers.intandem.tech/reference/delete_v3-license-directory-offerings-uid.md
- https://developers.intandem.tech/reference/delete_v3-license-offerings-uid.md
- https://developers.intandem.tech/reference/deletefeaturespackage.md
- https://developers.intandem.tech/reference/deletelicensefeature.md
- https://developers.intandem.tech/reference/engagements-report.md
- https://developers.intandem.tech/reference/get_api-operator-api-v1-features-id.md
- https://developers.intandem.tech/reference/get_api-operator-api-v1-features.md
- https://developers.intandem.tech/reference/get_api-operator-api-v1-packages-id.md
- https://developers.intandem.tech/reference/get_api-operator-api-v1-packages.md
- https://developers.intandem.tech/reference/get_business-accounts-v1-attributes.md
- https://developers.intandem.tech/reference/get_business-accounts-v1-branding.md
- https://developers.intandem.tech/reference/get_business-accounts-v1-identities.md
- https://developers.intandem.tech/reference/get_business-accounts-v1-usage-last-3-months-activity.md
- https://developers.intandem.tech/reference/get_business-staffs-v1-daily-staff-sign-ins.md
- https://developers.intandem.tech/reference/get_businesses-validate-login.md
- https://developers.intandem.tech/reference/get_businesses.md
- https://developers.intandem.tech/reference/get_oauth-userinfo.md
- https://developers.intandem.tech/reference/get_platform-v1-business-jobber-executions.md
- https://developers.intandem.tech/reference/get_platform-v1-business-jobber-flows.md
- https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-features.md
- https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-recurly-data.md
- https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-staffs-staff-uid.md
- https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-staffs.md
- https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-wizards-wizard-name.md
- https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-wizards.md
- https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid.md
- https://developers.intandem.tech/reference/get_platform-v1-directory-branding.md
- https://developers.intandem.tech/reference/get_platform-v1-scheduling-staff-staff-uid.md
- https://developers.intandem.tech/reference/get_platform-v1-scheduling-staff.md
- https://developers.intandem.tech/reference/get_platform-v1-tokens.md
- https://developers.intandem.tech/reference/get_platform-v1-webhooks.md
- https://developers.intandem.tech/reference/get_v2-settings-businesses-business-uid.md
- https://developers.intandem.tech/reference/get_v3-access-control-business-roles-uid.md
- https://developers.intandem.tech/reference/get_v3-access-control-business-roles.md
- https://developers.intandem.tech/reference/get_v3-access-control-permissions.md
# --- truncated at 32 KB (48 KB total) ---
# Full source: https://artifacts.apis.io/vcita/openapi/vcita-staff-business-role-api-openapi.yml