Audience
Manage user groups and user attributes for a company application.
Operations
GET
# List attribute definitions
POST
# Create attribute definition
GET
# Get attribute definition
PUT
# Update attribute definition
DEL
# Delete attribute definition
PATCH
# Bulk update attributes
GET
# List user attributes
GET
# Get user attribute by definition
PUT
# Create or update user attribute
DEL
# Delete user attribute
Parameters
company_id
string
Required
Enum
application_id
string
Required
Enum
page_no
integer
page_size
integer
name
string
slug
string
type
string
customer_editable
boolean
encrypted
boolean
pinned
boolean
is_locked
boolean
Response
200
List of definitions
UserAttributeDefinitionListDetail
items
array of object (UserAttributeDefinition)
Array of UserAttributeDefinition
_id
string
name
string
slug
string
description
string
type
string
validations
array of object (UserAttributeValidation)
Array of UserAttributeValidation
type
string
Enum
value
string
oneOf Schema from below
default_value
string
Nullable
oneOf Schema from below
oneOf Schema from below
encrypted
boolean
pinned
boolean
pin_order
number
customer_editable
boolean
is_locked
boolean
created_at
string
| date-time
modified_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
object (PageNumber)
PageNumber
type
string
current
integer
size
integer
item_total
integer
has_next
boolean
has_previous
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"559"
application_id:
"64b000000000000000000001"
Was this section helpful?
GET
Response
List attribute definitions
getUserAttributeDefinitions
Parameters
company_id
string
Required
Enum
application_id
string
Required
Enum
Request body
name
string
Required
slug
string
Required
description
string
Required
type
string
Required
Enum
Response
201
400
Definition created
UserAttributeDefinition
_id
string
name
string
slug
string
description
string
type
string
validations
array of object (UserAttributeValidation)
Array of UserAttributeValidation
type
string
Enum
value
string
oneOf Schema from below
default_value
string
Nullable
oneOf Schema from below
oneOf Schema from below
encrypted
boolean
pinned
boolean
pin_order
number
customer_editable
boolean
is_locked
boolean
created_at
string
| date-time
modified_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"559"
application_id:
"64b000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Create attribute definition
createUserAttributeDefinition
Parameters
company_id
string
Required
application_id
string
Required
definition_id
string
Required
Response
200
404
Definition
UserAttributeDefinition
_id
string
name
string
slug
string
description
string
type
string
validations
array of object (UserAttributeValidation)
Array of UserAttributeValidation
type
string
Enum
value
string
oneOf Schema from below
default_value
string
Nullable
oneOf Schema from below
oneOf Schema from below
encrypted
boolean
pinned
boolean
pin_order
number
customer_editable
boolean
is_locked
boolean
created_at
string
| date-time
modified_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"559"
application_id:
"64b000000000000000000001"
definition_id:
"64f666666666666666666666"
Was this section helpful?
GET
Response
Get attribute definition
getUserAttributeDefinitionById
Parameters
company_id
string
Required
application_id
string
Required
definition_id
string
Required
Request body
name
string
description
string
type
string
Enum
customer_editable
boolean
Response
200
400
404
Definition details
UserAttributeDefinition
_id
string
name
string
slug
string
description
string
type
string
validations
array of object (UserAttributeValidation)
Array of UserAttributeValidation
type
string
Enum
value
string
oneOf Schema from below
default_value
string
Nullable
oneOf Schema from below
oneOf Schema from below
encrypted
boolean
pinned
boolean
pin_order
number
customer_editable
boolean
is_locked
boolean
created_at
string
| date-time
modified_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"559"
application_id:
"64b000000000000000000001"
definition_id:
"64f888888888888888888888"
body:
body
Was this section helpful?
PUT
Response
Update attribute definition
updateUserAttributeDefinition
Parameters
company_id
string
Required
application_id
string
Required
definition_id
string
Required
Response
200
400
404
Deleted
DeleteDetail
message
string
success
boolean
oneOf Schema from below
Examples
Parameters
company_id:
"559"
application_id:
"64b000000000000000000001"
definition_id:
"64f777777777777777777777"
Was this section helpful?
DEL
Response
Delete attribute definition
deleteUserAttributeDefinitionById
Parameters
company_id
string
Required
Enum
application_id
string
Required
Enum
Request body
file_url
string
Required
attributes
array of object (BulkUpdateAttributeItem)
Required
Array of BulkUpdateAttributeItem
key
string
Required
value
string
Required
oneOf Schema from below
Response
202
400
Async update queued
BulkUserAttributesQueuedDetail
success
boolean
message
string
processing_type
string
Enum
job_id
string
status_code
integer
Enum
Examples
Parameters
company_id:
"559"
application_id:
"64b000000000000000000001"
body:
body
Was this section helpful?
PATCH
Response
Bulk update attributes
bulkUpdateUserAttributes
Parameters
company_id
string
Required
application_id
string
Required
user_id
string
Required
type
string
name
string
page_no
integer
page_size
integer
Response
200
List of user attributes
UserAttributeListDetail
items
array of object (UserAttribute)
Array of UserAttribute
_id
string
application_id
string
user_id
string
user_attribute_definition_id
string
attribute
object (UserAttributeKeyValue)
UserAttributeKeyValue
key
string
value
string
Nullable
oneOf Schema from below
oneOf Schema from below
type
string
updated_by
string
customer_overridden
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
object (PageNumber)
PageNumber
type
string
current
integer
size
integer
item_total
integer
has_next
boolean
has_previous
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"559"
application_id:
"64b000000000000000000001"
user_id:
"64f222222222222222222222"
Was this section helpful?
GET
Response
List user attributes
getUserAttributesForUser
Parameters
company_id
string
Required
application_id
string
Required
user_id
string
Required
definition_id
string
Required
Response
200
404
User attribute details
UserAttribute
_id
string
application_id
string
user_id
string
user_attribute_definition_id
string
attribute
object (UserAttributeKeyValue)
UserAttributeKeyValue
key
string
value
string
Nullable
oneOf Schema from below
oneOf Schema from below
type
string
updated_by
string
customer_overridden
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"559"
application_id:
"64b000000000000000000001"
user_id:
"64f222222222222222222222"
definition_id:
"64f666666666666666666666"
Was this section helpful?
GET
Response
Get user attribute by definition
getUserAttributeById
Parameters
company_id
string
Required
application_id
string
Required
user_id
string
Required
definition_id
string
Required
Request body
attribute
object (UserAttributeValue)
Required
UserAttributeValue
value
object
Required
The attribute value
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
201
400
404
Created attribute
UserAttribute
_id
string
application_id
string
user_id
string
user_attribute_definition_id
string
attribute
object (UserAttributeKeyValue)
UserAttributeKeyValue
key
string
value
string
Nullable
oneOf Schema from below
oneOf Schema from below
type
string
updated_by
string
customer_overridden
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"559"
application_id:
"64b000000000000000000001"
user_id:
"64f222222222222222222222"
definition_id:
"64f888888888888888888888"
body:
body
Was this section helpful?
PUT
Response
Create or update user attribute
updateUserAttribute
Parameters
company_id
string
Required
Enum
application_id
string
Required
Enum
user_id
string
Required
definition_id
string
Required
Response
200
404
Deleted
DeleteDetail
message
string
success
boolean
oneOf Schema from below
Examples
Parameters
company_id:
"559"
application_id:
"64b000000000000000000001"
user_id:
"64f222222222222222222222"
definition_id:
"64f999999999999999999999"
Was this section helpful?
DEL
Response
Delete user attribute
deleteUserAttribute
Operations
GET
# List group tags
GET
# List group categories
GET
# List groups by category
GET
# List groups
POST
# Create group
GET
# Get group by id
PATCH
# Patch group
DEL
# Delete group
GET
# List users in group
POST
# Refresh total users
Parameters
company_id
string
Required
Enum
application_id
string
Required
Enum
Response
200
Tags list
UserGroupTagsDetail
items
array of string
Examples
Parameters
company_id:
"559"
application_id:
"64b000000000000000000001"
Was this section helpful?
GET
Response
List group tags
getUserGroupTags
Parameters
company_id
string
Required
Enum
application_id
string
Required
Enum
category
string
Filter category by key.
Response
200
Categories list
UserGroupCategoriesDetail
items
array of object
Examples
Parameters
company_id:
"559"
application_id:
"64b000000000000000000001"
category:
"l1"
Was this section helpful?
GET
Response
List group categories
getUserGroupCategories
Parameters
company_id
string
Required
Enum
application_id
string
Required
Enum
Response
200
Categorised groups
UserGroupCategorisedDetail
user_groups
object
Examples
Parameters
company_id:
"559"
application_id:
"64b000000000000000000001"
Was this section helpful?
GET
Response
List groups by category
getCategorisedUserGroups
Parameters
company_id
string
Required
Enum
application_id
string
Required
Enum
status
string
type
string
name
string
group_uid
string
tags
string
category
string
page_no
integer
page_size
integer
Response
200
Paginated groups
UserGroupListDetail
items
array of object (UserGroup)
Array of UserGroup
_id
string
uid
number
name
string
description
string
file_url
string
application_id
string
type
string
status
string
category
string
tags
array of string
total_users
object
created_at
string
| date-time
modified_at
string
| date-time
is_active
boolean
__v
integer
page
object (PageNumber)
PageNumber
type
string
current
integer
size
integer
item_total
integer
has_next
boolean
has_previous
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"559"
application_id:
"64b000000000000000000001"
Was this section helpful?
GET
Response
List groups
getUserGroups
Parameters
company_id
string
Required
Enum
application_id
string
Required
Enum
Request body
name
string
Required
description
string
Required
category
string
Required
Enum
file_url
string
Required
Response
201
Group created
UserGroup
_id
string
uid
number
name
string
description
string
file_url
string
application_id
string
type
string
status
string
category
string
tags
array of string
total_users
object
created_at
string
| date-time
modified_at
string
| date-time
is_active
boolean
__v
integer
Examples
Parameters
company_id:
"559"
application_id:
"64b000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Create group
createUserGroup
Parameters
company_id
string
Required
application_id
string
Required
group_id
string
Required
Response
200
404
Group details
UserGroup
_id
string
uid
number
name
string
description
string
file_url
string
application_id
string
type
string
status
string
category
string
tags
array of string
total_users
object
created_at
string
| date-time
modified_at
string
| date-time
is_active
boolean
__v
integer
Examples
Parameters
company_id:
"559"
application_id:
"64b000000000000000000001"
group_id:
"64f111111111111111111111"
Was this section helpful?
GET
Response
Get group by id
getUserGroupById
Parameters
company_id
string
Required
application_id
string
Required
group_id
string
Required
Request body
file_url
string
name
string
description
string
Response
200
400
404
Patched group
UserGroup
_id
string
uid
number
name
string
description
string
file_url
string
application_id
string
type
string
status
string
category
string
tags
array of string
total_users
object
created_at
string
| date-time
modified_at
string
| date-time
is_active
boolean
__v
integer
Examples
Parameters
company_id:
"559"
application_id:
"64b000000000000000000001"
group_id:
"64f111111111111111111111"
body:
body
Was this section helpful?
PATCH
Response
Patch group
updateUserGroup
Parameters
company_id
string
Required
application_id
string
Required
group_id
string
Required
Response
200
404
Group deleted
DeleteDetail
message
string
success
boolean
oneOf Schema from below
Examples
Parameters
company_id:
"559"
application_id:
"64b000000000000000000001"
group_id:
"64f555555555555555555555"
Was this section helpful?
DEL
Response
Delete group
deleteUserGroup
Parameters
company_id
string
Required
application_id
string
Required
group_id
string
Required
q
string
cursor
string
Enum
direction
string
Enum
page_no
integer
page_size
integer
blacklisted_users
boolean
Response
200
404
Group users
UserGroupUsersDetail
items
array of object (UserSummary)
Array of UserSummary
user_id
string
emails
array of object (Email)
Array of Email
email
string
primary
boolean
verified
boolean
active
boolean
phone_numbers
array of object (PhoneNumber)
Array of PhoneNumber
phone
string
country_code
number
verified
boolean
primary
boolean
active
boolean
page
object (CursorPage)
CursorPage
type
string
current
integer
size
integer
has_next
boolean
has_prev
boolean
next_cursor
string
Nullable
prev_cursor
string
Nullable
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"559"
application_id:
"64b000000000000000000001"
group_id:
"64f111111111111111111111"
cursor:
"64f222222222222222222222"
direction:
"next"
page_no:
1
page_size:
10
Was this section helpful?
GET
Response
List users in group
getUsersByByGroupId
Parameters
company_id
string
Required
application_id
string
Required
group_id
string
Required
Response
202
404
Refresh started
RefreshDetail
message
string
uid
number
Examples
Parameters
company_id:
"559"
application_id:
"64b000000000000000000001"
group_id:
"64f111111111111111111111"
Was this section helpful?
POST
Response