Guide · Beginner · ⏱ ~5 min read
Green Check Access (Insights) provides API endpoints for reading data about your organization, the CRBs connected to your account, and the operational data flowing from their connected POS or invoice tracking systems. This guide maps out what's available and what each endpoint returns.
- Available endpoint groups and what each returns
- The difference between Service Provider and CRB scoped endpoints
- Data types sourced from connected POS integrations
- Where to check POS coverage for specific data points
| Group | Scope | What it returns |
|---|---|---|
| Service Provider | Your org | Your account details and list of connected CRBs |
| CRB | A specific CRB | Profile and configuration for an individual CRB |
| Documents | A specific CRB | Uploaded compliance documents (licenses, insurance, etc.) |
| Inventory | A specific CRB | Product quantities by location and date |
| Sales | A specific CRB | Transaction records with line items and compliance status |
| Customers | A specific CRB | Hashed customer records |
| Products | A specific CRB | Product catalog with THC/CBD content and pricing |
ℹ️ Data availability depends on POS connection
Inventory, sales, customer, and product data are only available for CRBs that have connected a supported POS or invoice tracking system. Limited data may be available for CRBs that have manually uploaded data. See the integration status page to check which data points are covered for each integration.
Service Provider endpoints return data scoped to your own organization. Use these to retrieve your account configuration and discover which CRBs are connected to your account.
| Endpoint | Description |
|---|---|
GET /service-providers/{sp_id} | Returns details about your own organization |
GET /service-providers/{sp_id}/crbs | Returns a list of all CRBs connected to your account — you can only query CRBs linked to your own sp_id |
CRB endpoints return data about a specific Cannabis Related Business using its unique identifier.
| Endpoint | Description |
|---|---|
GET /service-providers/{sp_id}/crbs/{crb_id} | Returns profile and configuration for a specific CRB |
Documents are files associated with a CRB — business licenses, insurance certificates, state registrations, and any other uploads collected during onboarding. These endpoints let you retrieve and download those files.
| Endpoint | Description |
|---|---|
GET /service-providers/{sp_id}/crbs/{crb_id}/documents | Returns a list of documents a CRB has shared with your account |
GET /service-providers/{sp_id}/crbs/{crb_id}/documents/{doc_id}/download | Returns a specific document as a base64-encoded blob |
💡 Tip — Fetching documents in bulk
To retrieve all documents for a CRB after they complete their onboarding application, start with
GET .../onboarding-templateto get document IDs from thestandard_requirementsarray, then loop through those IDs to call the download endpoint for each. See the Retrieving CRB onboarding templates tutorial for a complete walkthrough.
Inventory endpoints return quantity-on-hand data for products across a CRB's physical locations, sourced from their connected POS system.
| Endpoint | Description |
|---|---|
GET /service-providers/{sp_id}/crbs/{crb_id}/inventory | Returns a snapshot of inventory for a specific date |
GET /service-providers/{sp_id}/crbs/{crb_id}/inventory/{inventory_id} | Returns a single inventory record by ID |
GET /service-providers/{sp_id}/crbs/{crb_id}/inventory-locations/{location_id}/inventory | Returns inventory for a specific location on a specific date |
GET /service-providers/{sp_id}/crbs/{crb_id}/inventory-locations | Returns a list of the CRB's physical inventory locations |
GET /service-providers/{sp_id}/crbs/{crb_id}/inventory-locations/{location_id} | Returns details about a specific inventory location |
All inventory endpoints accept limit and offset query parameters for pagination.
- Integration status — Check data point coverage for each supported POS integration
- Integration overview — Authentication, core workflows, and the full integration lifecycle
- API integration workflow — Step-by-step tutorial for fetching paginated sales data
- API reference — Full schema and endpoint documentation