Company Management Endpoints
An overview of the Company Management category of endpoints.
The Company Management category encompasses a series of APIs designed to manage various aspects of companies within R1 Discover. These endpoints are vital for accessing and maintaining detailed information about companies, their locations, programs, activities, and users. Proper management of this data ensures that companies can efficiently organize and retrieve information critical to their operations.
Overview of Company Management APIs
Company management is crucial for maintaining an organized and efficient environment in R1 Discover. Below is a list of endpoints with their basic functionalities. Each endpoint is elaborated in the "Endpoints Detailed Description" section, where specifics about request formats, response structures, and examples are provided.
Endpoints
Company List: Retrieve a list of all companies within R1 Discover and their R1 Discover IDs.
View Company Programs: Access details about different programs offered by specific companies, crucial for user and admin account setups.
View Company Locations: Obtain information on various company locations. This data is necessary for setting up user and admin profiles linked to specific places.
Company Topic List: Gather details about which topics are available to a specific company within their R1 Discover account.
Company Activity List: Retrieve a list of activities available to a company's users. These activities are part of the company's engagement initiatives.
View Company User List: Pull the list of users in R1 Discover aligned to the Company(s) your API can access.
View Company Admins: Pull the list of admins in R1 Discover aligned to the Company(s) your API can access.
View Company Practitioners: Pull the list of admins that are Practitioners in R1 Discover aligned to the Company(s) your API can access. Users must be aligned to a Practitioner, this is how you can see all of the active practitioners.
Integration Points
Company Onboarding/Setup: Seamlessly integrate company data into the admins/users as they are setup in R1 Discover through the User Management APIs.
Data Retrieval: Accessing the locations, programs, topics and activities enables you to better navigate the User Management and Activity Detail endpoints.
Additional Resources
For developers looking to implement company management functionalities, we provide additional resources such as code snippets, SDKs, and integration guides available in the "Support and Resources" section of this documentation. These tools are designed to facilitate the development process and ensure best practices are followed when integrating our APIs.
Next Steps
After reviewing this section, developers should understand the scope and capabilities of our Company Management APIs. Proceed to the detailed descriptions for code samples, technical specifics, and interactive examples to begin integration. This comprehensive approach helps ensure that all company-related data is managed effectively and securely, reflecting the latest changes and updates in the system.
Last updated