CIcircleci
Organization

Create a new organization

Create a new organization. For VCS providers (GitHub/Bitbucket), this validates access and syncs org data. For standalone orgs, this creates a new CircleCI organization.

post/organization

Request

  • Base URL
    https://circleci.com/api/v2
  • URL
    https://circleci.com/api/v2/organization
  • Auth
    • API key in header Circle-Token
    • or HTTP bearer
    • or HTTP basic
    • or API key in query parameter circle-token

Request body

namestring required

The name of the organization.

vcs_type'github' | 'bitbucket' | 'circleci' required

The version control system type for the organization.

Example request

{
  "vcs_type": "github"
}

Response

The newly created organization

idstring required

The unique ID of the organization.

namestring required

The name of the organization.

slugstring required

Org slug in the form vcs-slug/org-name. For projects that use GitLab or GitHub App, use circleci as the vcs-slug and replace the org-name with the organization ID (found in Organization Settings).

vcs_type'github' | 'bitbucket' | 'circleci' required

The version control system type for the organization.

Example response

{
  "vcs_type": "github"
}

Changes

No recorded changes to this operation across all 1 revision of this API.