Loading Documentation Hub... Scanning documentation library
Loading Documentation Hub... Scanning documentation library
Loading Documentation Hub... Scanning documentation library
About Us About our platform and services
About Us About our platform and services
Завантаження документації... Підготовка контенту платформи Ring
Завантаження документації... Підготовка контенту платформи Ring
Завантаження документації... Підготовка контенту платформи Ring
Entities API
Manage organizations and businesses with 8 endpoints for comprehensive entity management, including role-based access control and industry-specific features.
Overview
Entities represent organizations, businesses, and professional groups within the Ring Platform ecosystem.
Key Features:
26 industry types with visual icons
Verification badge system
Confidential entity protection
Role-based access control
API Endpoints
GET /api/entitiesList entities with filtering and pagination
POST /api/entitiesCreate a new entity (requires MEMBER role)
GET /api/entities/{id}Get entity details by ID
PUT /api/entities/{id}Update entity information
DELETE /api/entities/{id}Delete entity (admin only)
POST /api/entities/{id}/verifyRequest entity verification
GET /api/entities/{id}/membersList entity members and roles
Entities API
Manage organizations and businesses with 8 endpoints for comprehensive entity management, including role-based access control and industry-specific features.
Overview
Entities represent organizations, businesses, and professional groups within the Ring Platform ecosystem.
Key Features:
26 industry types with visual icons
Verification badge system
Confidential entity protection
Role-based access control
API Endpoints
GET /api/entitiesList entities with filtering and pagination
POST /api/entitiesCreate a new entity (requires MEMBER role)
GET /api/entities/{id}Get entity details by ID
PUT /api/entities/{id}Update entity information
DELETE /api/entities/{id}Delete entity (admin only)
POST /api/entities/{id}/verifyRequest entity verification
GET /api/entities/{id}/membersList entity members and roles
Entities API
Manage organizations and businesses with 8 endpoints for comprehensive entity management, including role-based access control and industry-specific features.
Overview
Entities represent organizations, businesses, and professional groups within the Ring Platform ecosystem.
Key Features:
26 industry types with visual icons
Verification badge system
Confidential entity protection
Role-based access control
API Endpoints
GET /api/entitiesList entities with filtering and pagination
POST /api/entitiesCreate a new entity (requires MEMBER role)
GET /api/entities/{id}Get entity details by ID
PUT /api/entities/{id}Update entity information
DELETE /api/entities/{id}Delete entity (admin only)
POST /api/entities/{id}/verifyRequest entity verification
GET /api/entities/{id}/membersList entity members and roles
POST /api/entities/{id}/members
Entity Structure interface Entity {
typescript
Industry Types Ring Platform supports 26 industry types :
POST /api/entities/{id}/members
Entity Structure interface Entity {
typescript
Industry Types Ring Platform supports 26 industry types :
POST /api/entities/{id}/members
Entity Structure interface Entity {
typescript
Industry Types Ring Platform supports 26 industry types :
Technology & Software
Healthcare & Medical
Finance & Banking
Education & Training
Manufacturing & Industrial
Retail & E-commerce
Real Estate & Construction
Media & Entertainment
Transportation & Logistics
Energy & Utilities
Agriculture & Food
Legal & Professional Services
Non-profit & Social Impact
Government & Public Sector
Consulting & Business Services
Marketing & Advertising
Design & Creative
Sports & Recreation
Travel & Hospitality
Automotive
Aerospace & Defense
Biotechnology & Pharmaceuticals
Environmental & Sustainability
Mining & Resources
Telecommunications
Other
Technology & Software
Healthcare & Medical
Finance & Banking
Education & Training
Manufacturing & Industrial
Retail & E-commerce
Real Estate & Construction
Media & Entertainment
Transportation & Logistics
Energy & Utilities
Agriculture & Food
Legal & Professional Services
Non-profit & Social Impact
Government & Public Sector
Consulting & Business Services
Marketing & Advertising
Design & Creative
Sports & Recreation
Travel & Hospitality
Automotive
Aerospace & Defense
Biotechnology & Pharmaceuticals
Environmental & Sustainability
Mining & Resources
Telecommunications
Other
Technology & Software
Healthcare & Medical
Finance & Banking
Education & Training
Manufacturing & Industrial
Retail & E-commerce
Real Estate & Construction
Media & Entertainment
Transportation & Logistics
Energy & Utilities
Agriculture & Food
Legal & Professional Services
Non-profit & Social Impact
Government & Public Sector
Consulting & Business Services
Marketing & Advertising
Design & Creative
Sports & Recreation
Travel & Hospitality
Automotive
Aerospace & Defense
Biotechnology & Pharmaceuticals
Environmental & Sustainability
Mining & Resources
Telecommunications
Other
Implementation Examples
Create Entity
Implementation Examples
Create Entity
Implementation Examples
Create Entity const response = await fetch ( ' /api/entities ' , { method : ' POST ' , headers : { ' Content-Type ' : ' application/json ' , ' Authorization ' : ` Bearer ${ token } ` } , body : const response = await fetch ( ' /api/entities ' , { method : ' POST ' , headers : { ' Content-Type ' : ' application/json ' , ' Authorization ' : ` Bearer ${ token } ` } , body : const response = await fetch ( ' /api/entities ' , { method : ' POST ' , headers : { ' Content-Type ' : ' application/json ' , ' Authorization ' : ` Bearer ${ token } ` } , body :
List Entities with Filtering
Get Entity Details
List Entities with Filtering
Get Entity Details
List Entities with Filtering
Get Entity Details const response = await fetch ( ` /api/entities/ ${ entityId } ` ) const entity = await response . json () if ( entity . confidential && ! hasConfidentialAccess ) { // Handle confidential entity access } const response = await fetch ( ` /api/entities/ ${ entityId } ` ) const entity = await response . json () if ( entity . confidential && ! hasConfidentialAccess ) { // Handle confidential entity access } const response = await fetch ( ` /api/entities/ ${ entityId } ` ) const entity = await response . json () if ( entity . confidential && ! hasConfidentialAccess ) { // Handle confidential entity access }
Access Control
Entity Visibility
Public Entities : Visible to all usersConfidential Entities : Require CONFIDENTIAL role or higher
Entity Management
Create : Requires MEMBER roleUpdate : Entity members with ADMIN roleDelete : Platform ADMIN onlyVerify : Special verification process
Member Roles
OWNER : Full entity controlADMIN : Manage members and contentMEMBER : Basic entity access
Verification Process Entities can request verification badges:
Submit verification request
Provide required documentation
Platform review process
Verification badge granted
Benefits of Verification:
Enhanced credibility
Priority in search results
Access to premium features
Confidential entity creation
Access Control
Entity Visibility
Public Entities : Visible to all usersConfidential Entities : Require CONFIDENTIAL role or higher
Entity Management
Create : Requires MEMBER roleUpdate : Entity members with ADMIN roleDelete : Platform ADMIN onlyVerify : Special verification process
Member Roles
OWNER : Full entity controlADMIN : Manage members and contentMEMBER : Basic entity access
Verification Process Entities can request verification badges:
Submit verification request
Provide required documentation
Platform review process
Verification badge granted
Benefits of Verification:
Enhanced credibility
Priority in search results
Access to premium features
Confidential entity creation
Access Control
Entity Visibility
Public Entities : Visible to all usersConfidential Entities : Require CONFIDENTIAL role or higher
Entity Management
Create : Requires MEMBER roleUpdate : Entity members with ADMIN roleDelete : Platform ADMIN onlyVerify : Special verification process
Member Roles
OWNER : Full entity controlADMIN : Manage members and contentMEMBER : Basic entity access
Verification Process Entities can request verification badges:
Submit verification request
Provide required documentation
Platform review process
Verification badge granted
Benefits of Verification:
Enhanced credibility
Priority in search results
Access to premium features
Confidential entity creation
JSON
.
stringify
(
{
name : ' Tech Innovators Inc ' ,
description : ' Leading software development company ' ,
industry : ' TECHNOLOGY_SOFTWARE ' ,
website : ' https://techinnovators.com ' ,
JSON
.
stringify
(
{
name : ' Tech Innovators Inc ' ,
description : ' Leading software development company ' ,
industry : ' TECHNOLOGY_SOFTWARE ' ,
website : ' https://techinnovators.com ' ,
JSON
.
stringify
(
{
name : ' Tech Innovators Inc ' ,
description : ' Leading software development company ' ,
industry : ' TECHNOLOGY_SOFTWARE ' ,
website : ' https://techinnovators.com ' ,
location : ' San Francisco, CA '
} )
} )
const entity = await response . json ()
location : ' San Francisco, CA '
} )
} )
const entity = await response . json ()
location : ' San Francisco, CA '
} )
} )
const entity = await response . json ()
