Organizations & Teams API

Overview

The Organizations API allows you to manage team accounts, invite members, and share API access across your organization. Perfect for enterprises that need centralized billing and usage tracking.

Features

• Team Management: Add and remove team members
• Role-Based Access: Admin, Member, and Read-Only roles
• Centralized Billing: Single invoice for entire organization
• Usage Analytics: Track API usage per team member
• Invitation System: Invite users via email

Endpoints

Organization Dashboard

GET /organizations/dashboard

Returns organization details and member list.

Response:

{
  "organization": {
    "id": "org_123",
    "name": "Acme Energy Trading",
    "created_at": "2025-01-15T10:00:00Z",
    "plan": "business",
    "member_count": 5,
    "api_calls_this_month": 45000
  },
  "members": [
    {
      "id": "user_456",
      "email": "[email protected]",
      "role": "admin",
      "joined_at": "2025-01-15T10:00:00Z"
    }
  ]
}

Add Team Member

POST /organizations/members

Request Body:

{
  "email": "[email protected]",
  "role": "member"
}

Update Member Role

PATCH /organizations/members/:id

Request Body:

{
  "role": "admin"
}

Remove Member

DELETE /organizations/members/:id

Send Invitation

POST /organizations/invitations

Request Body:

{
  "email": "[email protected]",
  "role": "member",
  "message": "Join our team on OilPriceAPI"
}

Accept Invitation

GET /organizations/invitations/:id/accept
POST /organizations/invitations/:id/confirm_accept

Roles & Permissions

Pricing

Organizations features are available on Business and Enterprise plans.

Get Beta Access