Skip to main content

Me

Retrieve information about the requesting user's organization.

Base URL: https://gate.zequenze.com/api/v1

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

Endpoints

GET /me/organization/

Retrieves organization information for the authenticated user, including organization details, settings, and user's role within the organization.

Parameters:

This endpoint does not accept any parameters.

Example Request:

GET /api/v1/me/organization/
Authorization: Bearer <your-api-token>

Example Response:

{
  "id": "org_12345",
  "name": "Acme Corporation",
  "display_name": "Acme Corp",
  "description": "Technology solutions provider",
  "domain": "acme.com",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-03-20T14:45:00Z",
  "settings": {
    "timezone": "UTC",
    "locale": "en-US",
    "features": {
      "api_access": true,
      "advanced_reporting": true
    }
  },
  "user_role": {
    "role": "admin",
    "permissions": [
      "read:organization",
      "write:organization",
      "manage:users"
    ],
    "joined_at": "2024-01-15T10:30:00Z"
  },
  "billing": {
    "plan": "enterprise",
    "status": "active",
    "next_billing_date": "2024-04-15T00:00:00Z"
  }
}

Response Status Codes:

Status Description
200 Organization information retrieved successfully
401 Authentication required or invalid token
403 Insufficient permissions to access organization data
404 User not associated with any organization

Best Practices

  • Token Security: Always store API tokens securely and never expose them in client-side code
  • Caching: Organization data changes infrequently, consider implementing appropriate caching strategies
  • Error Handling: Implement proper error handling for cases where users might not be associated with an organization
  • Rate Limiting: Respect API rate limits when making frequent requests