EvoHub Docs Sign in

API reference

Organization API

Use with AI
View as MarkdownThis page as plain text, for pasting into an AI tool Open in ClaudeAsk Claude questions about this page Open in ChatGPTAsk ChatGPT questions about this page
Connect to Cursor / VS Code / ClaudeSearch and read these docs from your AI tool (MCP server)

MCP server URL

https://docs-dev.evohub.io/mcp

Add to CursorAdd to VS Code

Claude Code

claude mcp add --transport http evohub-docs-docs https://docs-dev.evohub.io/mcp

Claude (claude.ai and Claude Desktop): Settings → Connectors → Add custom connector, and paste the URL above.

Claude Desktop — claude_desktop_config.json

{
  "mcpServers": {
    "evohub-docs-docs": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://docs-dev.evohub.io/mcp"
      ]
    }
  }
}

Cursor — ~/.cursor/mcp.json

{
  "mcpServers": {
    "evohub-docs-docs": {
      "url": "https://docs-dev.evohub.io/mcp"
    }
  }
}

VS Code — .vscode/mcp.json

{
  "servers": {
    "evohub-docs-docs": {
      "type": "http",
      "url": "https://docs-dev.evohub.io/mcp"
    }
  }
}

llms.txtllms-full.txt

Version 1.0 OpenAPI 3.1.0

The Organization API: the people in your organization, its teams, custom roles and who holds them, invitations, organization settings and its audit log. Use it to keep EvoHub in step with your directory or HR system.

Authentication. Send an API key as Authorization: Bearer evohub_… or X-API-Key: evohub_…. A key works in one organization. See API keys and scopes and Errors in these docs.

Permissions. Each operation names the permission it needs (x-evohub-permission); an API key needs it among its scopes. A key is always held to its scopes, even one made by an administrator, and it never counts as an organization owner or administrator: what only they may do (giving or taking the Admin standing, editing an administrator, editing the default roles) is refused with 403 ADMIN_ONLY. A key can never grant more than it holds: a role, invitation or team membership that would hand out a permission the key does not hold is 403 FORBIDDEN, naming the permission. A refusal is never 401.

What a key cannot do. Signing in and everything a person does to their own account (profile, password, two-factor authentication, sessions, connected accounts, devices, switching or creating organizations, accepting invitations), managing API keys and agents, the login policy, and deleting the organization are for a person signed in to the console. Those routes are listed in x-route-check.not-public with the reason; a key that calls one gets 403.

Responses. Success is {"data": …, "success": true}. Errors are {"error": {"code", "message", "request_id"}}; VALIDATION_FAILED adds details. request_id is the X-Request-ID of the response — quote it to support. The codes are VALIDATION_ERROR (400, the message names the field), VALIDATION_FAILED, INVALID_BODY, UNKNOWN_PERMISSION, NOT_FOUND, FORBIDDEN, ADMIN_ONLY, NOT_A_PERSON, SLUG_TAKEN and INTERNAL_ERROR. Times are RFC 3339 in UTC. Ids carry a type prefix (usr_, team_, role_, inv_, org_).

Chat apps (Slack, Microsoft Teams) are connected in On-Call: see the On-Call API reference.

Servers

  • https://evohub.io

Authentication

  • bearerAuth HTTP Bearer
    An EvoHub API key (evohub_…) as a bearer token.
  • apiKeyHeader API key in the header X-API-Key
    An EvoHub API key (evohub_…).

Members

The people in the organization.

GET/api/v1/usersList members
GET/api/v1/users/{id}Get a member
DELETE/api/v1/users/{id}Remove a member
PATCH/api/v1/users/{id}Update a member
GET/api/v1/users/{userId}/rolesList a member's roles

Me

Who the key belongs to, and their own settings.

GET/api/v1/users/meWho the key belongs to
GET/api/v1/users/me/preferencesGet email preferences
GET/api/v1/users/me/preferences/dashboardGet the console home layout

Teams

Teams and their members.

GET/api/v1/teamsList teams
POST/api/v1/teamsCreate a team
DELETE/api/v1/teams/{id}Delete a team
PATCH/api/v1/teams/{id}Update a team
GET/api/v1/teams/{id}/membersList a team's members
POST/api/v1/teams/{id}/membersAdd a member to a team
DELETE/api/v1/teams/{id}/members/{userId}Remove a member from a team
GET/api/v1/teams/{id}/rolesList a team's roles

Roles

Custom roles, the permission catalog, and who holds which role.

GET/api/v1/permissionsList the permission catalog
GET/api/v1/rolesList roles
POST/api/v1/rolesCreate a role
DELETE/api/v1/roles/{id}Delete a role
PATCH/api/v1/roles/{id}Update a role
GET/api/v1/roles/{id}/usersList who holds a role directly
POST/api/v1/roles/{id}/usersGive a role to a member
DELETE/api/v1/roles/{id}/users/{userId}Take a role from a member
GET/api/v1/roles/{id}/teamsList the teams holding a role
POST/api/v1/roles/{id}/teamsGive a role to a team
DELETE/api/v1/roles/{id}/teams/{teamId}Take a role from a team

Invitations

Invite people by email.

GET/api/v1/invitationsList invitations
POST/api/v1/invitationsInvite someone
POST/api/v1/invitations/{id}/resendResend an invitation
DELETE/api/v1/invitations/{id}Cancel an invitation

Organization

The organization's name and settings.

GET/api/v1/organizationsGet the organization
PATCH/api/v1/organizations/{id}Rename the organization

Audit log

Who changed what in the organization.

GET/api/v1/audit-logsList the audit log

Last updated