BizCARE MyInvois
Shopify Integration/Organization Management

Get Organization

Retrieve detailed information about a specific organization

Get Organization

Retrieve detailed information about a specific organization, including member information and premium tier data.

Endpoint

GET /api/integrations/organizations/{id}

Path Parameters

ParameterTypeRequiredDescription
idstringYesThe unique identifier of the organization

Response Format

{
  "id": "org-123",
  "name": "Acme Corporation",
  "slug": "acme-corp",
  "logo": "https://example.com/logos/acme.png",
  "memberCount": 25,
  "premiumTier": {
    "id": "tier-premium",
    "name": "Premium",
    "features": [
      "advanced-reporting",
      "priority-support",
      "custom-integrations",
      "unlimited-users"
    ],
    "limits": {
      "maxUsers": 1000,
      "maxStorage": "100GB",
      "apiCallsPerMonth": 100000
    }
  },
  "members": [
    {
      "id": "member-456",
      "userId": "user-789",
      "role": "admin",
      "user": {
        "id": "user-789",
        "name": "John Doe",
        "email": "john@acme.com"
      },
      "createdAt": "2024-01-15T10:30:00Z"
    },
    {
      "id": "member-789",
      "userId": "user-123",
      "role": "customer",
      "user": {
        "id": "user-123",
        "name": "Jane Smith",
        "email": "jane@acme.com"
      },
      "createdAt": "2024-01-20T14:15:00Z"
    }
  ],
  "createdAt": "2024-01-10T08:00:00Z"
}

Examples

Basic Request

curl -X GET "https://api.example.com/api/integrations/organizations/org-123" \
  -H "X-Invois-Key: your-api-key-here"

JavaScript Example

const response = await fetch('https://api.example.com/api/integrations/organizations/org-123', {
  method: 'GET',
  headers: {
    'X-Invois-Key': 'your-api-key-here',
    'Content-Type': 'application/json'
  }
});

const organization = await response.json();
console.log(`Organization: ${organization.name} has ${organization.memberCount} members`);

Response Fields

Organization Fields

FieldTypeDescription
idstringUnique organization identifier
namestringOrganization name
slugstringURL-friendly organization identifier
logostringOrganization logo URL (nullable)
memberCountintegerTotal number of organization members
premiumTierobjectPremium tier information (nullable)
membersarrayArray of organization members
createdAtstringOrganization creation timestamp

Member Fields

FieldTypeDescription
idstringUnique membership identifier
userIdstringID of the user
rolestringMember's role in the organization
userobjectBasic user information
createdAtstringMembership creation timestamp

Premium Tier Fields

FieldTypeDescription
idstringPremium tier identifier
namestringTier name
featuresarrayList of available features
limitsobjectUsage limits and quotas

Member Roles

Organization members can have the following roles:

  • owner - Full ownership and control of the organization
  • admin - Administrative access and member management
  • customer - Standard member access

Premium Tier Features

Premium tiers may include features such as:

  • advanced-reporting - Enhanced analytics and reporting
  • priority-support - Dedicated customer support
  • custom-integrations - Custom API integrations
  • unlimited-users - No user count restrictions
  • advanced-security - Enhanced security features

Error Responses

  • 401 Unauthorized - Invalid or missing API key
  • 404 Not Found - Organization not found
  • 429 Too Many Requests - Rate limit exceeded

Use Cases

This endpoint is useful for:

  • Displaying organization details and member lists
  • Checking premium tier capabilities
  • Managing organization settings
  • Understanding organization structure and permissions

Next Steps