oCoreoCore Docs
API Reference

Organizations

List all organizations

Returns a paginated list of all organizations with optional search.

GET
/admin/orgs

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Query Parameters

pageinteger

Page number

limitinteger

Page size

searchstring

Search by name or slug

curl -X GET "//api.ocore.dev/api/admin/orgs?page=0&limit=0&search=%3Cstring%3E" \
  -H "Authorization: <token>"

OK

{
  "orgs": [
    {
      "createdAt": "string",
      "deactivatedAt": "string",
      "id": "string",
      "instanceCount": 0,
      "lastActivity": "string",
      "memberCount": 0,
      "name": "string",
      "serverCount": 0,
      "slug": "string",
      "storageUsed": 0
    }
  ],
  "total": 0
}

Create an organization

Creates a new organization as a server admin.

POST
/admin/orgs

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Organization details

namestring
ownerUserIdstring
slugstring
curl -X POST "//api.ocore.dev/api/admin/orgs" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "ownerUserId": "string",
    "slug": "string"
  }'

Created

{
  "createdAt": "string",
  "deactivatedAt": "string",
  "id": "string",
  "instanceCount": 0,
  "lastActivity": "string",
  "memberCount": 0,
  "name": "string",
  "serverCount": 0,
  "slug": "string",
  "storageUsed": 0
}

Get organization details

Returns detailed information about a specific organization.

GET
/admin/orgs/{id}

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Organization ID

Format: "uuid"
curl -X GET "//api.ocore.dev/api/admin/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: <token>"

OK

{
  "createdAt": "string",
  "deactivatedAt": "string",
  "id": "string",
  "instanceCount": 0,
  "lastActivity": "string",
  "memberCount": 0,
  "name": "string",
  "serverCount": 0,
  "slug": "string",
  "storageUsed": 0
}

Delete an organization

Permanently deletes an organization and all its resources.

DELETE
/admin/orgs/{id}

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Organization ID

Format: "uuid"
curl -X DELETE "//api.ocore.dev/api/admin/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: <token>"

OK

{
  "message": "string"
}

Deactivate an organization

Deactivates an organization, disabling all its resources.

POST
/admin/orgs/{id}/deactivate

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Organization ID

Format: "uuid"
curl -X POST "//api.ocore.dev/api/admin/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/deactivate" \
  -H "Authorization: <token>"

OK

{
  "message": "string"
}

List organization members

Returns a paginated list of members for an organization.

GET
/admin/orgs/{id}/members

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Organization ID

Format: "uuid"

Query Parameters

pageinteger

Page number

limitinteger

Page size

curl -X GET "//api.ocore.dev/api/admin/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/members?page=0&limit=0" \
  -H "Authorization: <token>"

OK

{
  "members": [
    {
      "email": "string",
      "joinedAt": "string",
      "name": "string",
      "roleId": "string",
      "roleName": "string",
      "status": "string",
      "userId": "string"
    }
  ],
  "total": 0
}

Add member to org

Adds an existing user to an organization with the specified role.

POST
/admin/orgs/{id}/members

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

User and role

roleNameRequiredstring
userIdRequiredstring

Path Parameters

idRequiredstring

Organization ID

Format: "uuid"
curl -X POST "//api.ocore.dev/api/admin/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/members" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "roleName": "string",
    "userId": "string"
  }'

Created

{
  "email": "string",
  "joinedAt": "string",
  "name": "string",
  "roleId": "string",
  "roleName": "string",
  "status": "string",
  "userId": "string"
}

Remove org member

Removes a member from an organization. Cannot remove the last owner.

DELETE
/admin/orgs/{id}/members/{userId}

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Organization ID

Format: "uuid"
userIdRequiredstring

User ID

Format: "uuid"
curl -X DELETE "//api.ocore.dev/api/admin/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/members/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: <token>"

No Content

Change org member role

Changes the role of a member within an organization.

PUT
/admin/orgs/{id}/members/{userId}/role

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

New role

roleNameRequiredstring

Path Parameters

idRequiredstring

Organization ID

Format: "uuid"
userIdRequiredstring

User ID

Format: "uuid"
curl -X PUT "//api.ocore.dev/api/admin/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/members/497f6eca-6276-4993-bfeb-53cbbbba6f08/role" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "roleName": "string"
  }'

OK

{
  "message": "string"
}

Reactivate an organization

Reactivates a previously deactivated organization.

POST
/admin/orgs/{id}/reactivate

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Organization ID

Format: "uuid"
curl -X POST "//api.ocore.dev/api/admin/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/reactivate" \
  -H "Authorization: <token>"

OK

{
  "message": "string"
}

Transfer organization ownership

Transfers ownership of an organization from one user to another.

POST
/admin/orgs/{id}/transfer-ownership

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Transfer details

toUserIdstring

Path Parameters

idRequiredstring

Organization ID

Format: "uuid"
curl -X POST "//api.ocore.dev/api/admin/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/transfer-ownership" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "toUserId": "string"
  }'

OK

{
  "message": "string"
}

Get current organization details

Returns the organization details for the current tenant context, including member count.

GET
/org

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

curl -X GET "//api.ocore.dev/api/org" \
  -H "Authorization: <token>"

OK

{
  "createdAt": "string",
  "id": "string",
  "logoUrl": "string",
  "memberCount": 0,
  "name": "string",
  "slug": "string"
}

Delete organization

Permanently deletes the organization. Only the organization owner can perform this action.

DELETE
/org

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

curl -X DELETE "//api.ocore.dev/api/org" \
  -H "Authorization: <token>"

OK

{
  "message": "string"
}

Update organization details

Updates the organization's name, slug, and/or logo URL. Requires manage:org_settings permission.

PUT
/org

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Organization fields to update

logoUrlstring
namestring
slugstring
curl -X PUT "//api.ocore.dev/api/org" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "logoUrl": "string",
    "name": "string",
    "slug": "string"
  }'

OK

{
  "id": "string",
  "logoUrl": "string",
  "name": "string",
  "slug": "string"
}

Transfer organization ownership

Transfers ownership of the organization to another member. Requires the current owner's password.

POST
/org/transfer-ownership

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

New owner ID and password

newOwnerIdstring
passwordstring
curl -X POST "//api.ocore.dev/api/org/transfer-ownership" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "newOwnerId": "string",
    "password": "string"
  }'

OK

{
  "message": "string"
}

Create a new organization

Creates a new organization with the authenticated user as the owner. Auto-generates a slug if not provided.

POST
/user/orgs

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Organization details

namestring
slugstring
curl -X POST "//api.ocore.dev/api/user/orgs" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "slug": "string"
  }'

Created

{
  "createdAt": "string",
  "id": "string",
  "logoUrl": "string",
  "name": "string",
  "slug": "string"
}

Was this page helpful?
Edit on GitHub

S S H Keys

Previous Page

Organization Settings

Next Page