Clerk · Capability
Clerk Backend Api — Organizations
Clerk Organizations capability. 11 operations. Lead operation: Get a List of Organizations for an Instance.
Capability Spec
naftiko: 1.0.0-alpha2
info:
label: Clerk Backend Api — Organizations
description: 'Clerk Organizations capability. 11 operations. Lead operation: Get a List of Organizations for an Instance.'
tags:
- Clerk
- Organizations
created: '2026-05-22'
modified: '2026-05-22'
binds:
- namespace: env
keys:
CLERK_SECRET_KEY: CLERK_SECRET_KEY
capability:
consumes:
- type: http
namespace: clerk-backend-api-organizations
baseUri: https://api.clerk.com/v1
description: Clerk clerk-backend-api Organizations business capability.
resources:
- name: organizations
path: /organizations
operations:
- name: ListOrganizations
method: GET
description: Get a List of Organizations for an Instance
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: include_members_count
in: query
type: boolean
description: Flag to denote whether the member counts of each organization should be included in the response or not.
required: false
- name: include_missing_member_with_elevated_permissions
in: query
type: boolean
description: Flag to denote whether or not to include a member with elevated permissions who is not currently a member of the organization.
required: false
- name: query
in: query
type: string
description: 'Returns organizations with ID, name, or slug that match the given query.
Uses exact match for organization ID and partial match for name and slug.'
required: false
- name: user_id
in: query
type: array
description: 'Returns organizations that include any of the specified user IDs as members. Any user IDs not found are ignored.
For each user ID, the `+` and `-` can be prepended to the ID, which denote whether the
'
required: false
- name: organization_id
in: query
type: array
description: 'Returns organizations with the organization IDs specified. Any organization IDs not found are ignored.
For each organization ID, the `+` and `-` can be prepended to the ID, which denote whether the
re'
required: false
- name: order_by
in: query
type: string
description: 'Allows to return organizations in a particular order.
At the moment, you can order the returned organizations either by their `name`, `created_at` or `members_count`.
In order to specify the direction'
required: false
- name: CreateOrganization
method: POST
description: Create an Organization
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: organizations-organization-id
path: /organizations/{organization_id}
operations:
- name: GetOrganization
method: GET
description: Retrieve an Organization by ID or Slug
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: organization_id
in: path
type: string
description: The ID or slug of the organization
required: true
- name: include_members_count
in: query
type: boolean
description: Flag to denote whether or not the organization's members count should be included in the response.
required: false
- name: include_missing_member_with_elevated_permissions
in: query
type: boolean
description: Flag to denote whether or not to include a member with elevated permissions who is not currently a member of the organization.
required: false
- name: UpdateOrganization
method: PATCH
description: Update an Organization
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: organization_id
in: path
type: string
description: The ID of the organization to update
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: DeleteOrganization
method: DELETE
description: Delete an Organization
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: organization_id
in: path
type: string
description: The ID of the organization to delete
required: true
- name: organizations-organization-id-metadata
path: /organizations/{organization_id}/metadata
operations:
- name: MergeOrganizationMetadata
method: PATCH
description: Merge and Update Metadata for an Organization
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: organization_id
in: path
type: string
description: The ID of the organization for which metadata will be merged or updated
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: organizations-organization-id-logo
path: /organizations/{organization_id}/logo
operations:
- name: UploadOrganizationLogo
method: PUT
description: Upload a Logo for the Organization
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: organization_id
in: path
type: string
description: The ID of the organization for which to upload a logo
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: DeleteOrganizationLogo
method: DELETE
description: Delete the Organization's Logo.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: organization_id
in: path
type: string
description: The ID of the organization for which the logo will be deleted.
required: true
- name: organizations-organization-id-billing-subscription
path: /organizations/{organization_id}/billing/subscription
operations:
- name: GetOrganizationBillingSubscription
method: GET
description: Retrieve an Organization's Billing Subscription
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: organization_id
in: path
type: string
description: The ID of the organization whose subscription to retrieve
required: true
- name: organizations-organization-id-billing-credits
path: /organizations/{organization_id}/billing/credits
operations:
- name: GetOrganizationBillingCreditBalance
method: GET
description: Retrieve an Organization's Credit Balance
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: organization_id
in: path
type: string
description: The ID of the organization whose credit balance to retrieve
required: true
- name: AdjustOrganizationBillingCreditBalance
method: POST
description: Adjust an Organization's Credit Balance
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: organization_id
in: path
type: string
description: The ID of the organization whose credit balance to adjust
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true