Scanning documentation library
Scanning documentation library
Scanning documentation library
Manage organizations and businesses with 8 endpoints for comprehensive entity management, including role-based access control and industry-specific features.
Entities represent organizations, businesses, and professional groups within the Ring Platform ecosystem.
Key Features:
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}/membersAdd member to entity
Ring Platform supports 26 industry types:
const response = await fetch('/api/entities', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${token}`
},
body: 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()
const response = await fetch(`/api/entities/${entityId}`)
const entity = await response.json()
if (entity.confidential && !hasConfidentialAccess) {
// Handle confidential entity access
}Entities can request verification badges:
Benefits of Verification:
Ready to create your first entity? Check our Getting Started guide.
Manage organizations and businesses with 8 endpoints for comprehensive entity management, including role-based access control and industry-specific features.
Entities represent organizations, businesses, and professional groups within the Ring Platform ecosystem.
Key Features:
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}/membersAdd member to entity
Ring Platform supports 26 industry types:
const response = await fetch('/api/entities', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${token}`
},
body: 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()
const response = await fetch(`/api/entities/${entityId}`)
const entity = await response.json()
if (entity.confidential && !hasConfidentialAccess) {
// Handle confidential entity access
}Entities can request verification badges:
Benefits of Verification:
Ready to create your first entity? Check our Getting Started guide.
Manage organizations and businesses with 8 endpoints for comprehensive entity management, including role-based access control and industry-specific features.
Entities represent organizations, businesses, and professional groups within the Ring Platform ecosystem.
Key Features:
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}/membersAdd member to entity
Ring Platform supports 26 industry types:
const response = await fetch('/api/entities', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${token}`
},
body: 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()
const response = await fetch(`/api/entities/${entityId}`)
const entity = await response.json()
if (entity.confidential && !hasConfidentialAccess) {
// Handle confidential entity access
}Entities can request verification badges:
Benefits of Verification:
Ready to create your first entity? Check our Getting Started guide.