API Reference
Buyer Cloud HomeGuidesAPI ReferenceChangelog

Role management

get
https://{buzz_key}.api.beeswax.com/rest/v2/roles

Endpoints for managing roles, including creation, update, retrieval, and deletion. Supports bulk operations and permission assignments.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
string
alternative_id__in
array of strings

Multiple values may be separated by commas.

alternative_id__in
boolean
string
string
alternative_id__not_in
array of strings

Multiple values may be separated by commas.

alternative_id__not_in
string
string
boolean

Archived roles cannot add new users

date-time
date-time
date-time
boolean
date-time
date-time
date-time | null
enum

The date and time the object was first created

  • today - From last midnight to next midnight
  • yesterday - The last complete calendar day
  • last_24_hours - The last 24 hours (as opposed to today, which is from midnight to midnight)
  • this_week - From midnight the previous Sunday until midnight the coming Sunday
  • last_week - The last complete calendar week
  • this_year - From the January 1 to December 31 this year
  • last_year - The last complete calendar year
  • this_month - From the first day to the last day of the current month
  • last_month - The last complete calendar month
  • this_quarter - From the first day to the last day of the current quarter
  • last_quarter - The last complete calendar quarter
  • last_7_days - From midnight 7 days ago to the present
  • last_7_complete_days - From midnight 7 days ago to last midnight
  • last_14_days - From midnight 14 days ago to the present
  • last_14_complete_days - From midnight 14 days ago to last midnight
  • last_30_days - From midnight 30 days ago to the present
  • last_30_complete_days - From midnight 30 days ago to last midnight
  • last_90_days - From midnight 90 days ago to the present
  • last_90_complete_days - From midnight 90 days ago to last midnight
  • last_365_days - From midnight 365 days ago to the present
  • last_365_complete_days - From midnight 365 days ago to last midnight
  • past - Any date in the past. Useful for Buzz queries against end_date and similar fields
  • future - Any date in the future. Useful for Buzz queries against end_date and similar fields
  • until_past_24_hours - From the very first date in the past and up until past 24 hours
number
number
number
id__in
array of numbers

Multiple values may be separated by commas.

id__in
number
number
number
id__not_in
array of numbers

Multiple values may be separated by commas.

id__not_in
string
string
name__in
array of strings

Multiple values may be separated by commas.

name__in
boolean
string
string
name__not_in
array of strings

Multiple values may be separated by commas.

name__not_in
string

Which field to use when ordering the results.

integer
integer
integer
parent_role_id__in
array of integers

Multiple values may be separated by commas.

parent_role_id__in
boolean
integer
integer
integer
parent_role_id__not_in
array of integers

Multiple values may be separated by commas.

parent_role_id__not_in
date-time
date-time
date-time
boolean
date-time
date-time
date-time | null
enum

The date and time the object was last updated

  • today - From last midnight to next midnight
  • yesterday - The last complete calendar day
  • last_24_hours - The last 24 hours (as opposed to today, which is from midnight to midnight)
  • this_week - From midnight the previous Sunday until midnight the coming Sunday
  • last_week - The last complete calendar week
  • this_year - From the January 1 to December 31 this year
  • last_year - The last complete calendar year
  • this_month - From the first day to the last day of the current month
  • last_month - The last complete calendar month
  • this_quarter - From the first day to the last day of the current quarter
  • last_quarter - The last complete calendar quarter
  • last_7_days - From midnight 7 days ago to the present
  • last_7_complete_days - From midnight 7 days ago to last midnight
  • last_14_days - From midnight 14 days ago to the present
  • last_14_complete_days - From midnight 14 days ago to last midnight
  • last_30_days - From midnight 30 days ago to the present
  • last_30_complete_days - From midnight 30 days ago to last midnight
  • last_90_days - From midnight 90 days ago to the present
  • last_90_complete_days - From midnight 90 days ago to last midnight
  • last_365_days - From midnight 365 days ago to the present
  • last_365_complete_days - From midnight 365 days ago to last midnight
  • past - Any date in the past. Useful for Buzz queries against end_date and similar fields
  • future - Any date in the future. Useful for Buzz queries against end_date and similar fields
  • until_past_24_hours - From the very first date in the past and up until past 24 hours
Responses

401

Unauthorized.

403

Permission denied.

500

Internal server error.

Updated 2 months ago

Language
Credentials
:
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 2 months ago