GitButler Logo
API Reference

Organization

Operations about organizations

GET
/organization/{slug}

Get Organization Slug

Get information for an organization

/organization/{slug}

Path Parameters

slug
Required
string

Organization slug

curl -X GET "https://app.gitbutler.com/api/organization/string"

Get information for an organization

PUT
/organization/{slug}

Put Organization Slug

Update an organization

/organization/{slug}

Request Body

application/jsonOptional

namestring

Organization name

descriptionstring

Description

Path Parameters

slug
Required
string

Organization slug

curl -X PUT "https://app.gitbutler.com/api/organization/string" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string"
  }'

Update an organization

PUT
/organization/{slug}/{login}

Put Organization Slug Login

Update an organization user

/organization/{slug}/{login}

Request Body

application/jsonRequired

role
Required
string

Role (owner, member)

Path Parameters

slug
Required
string

Organization slug

login
Required
string

User to update

curl -X PUT "https://app.gitbutler.com/api/organization/string/string" \
  -H "Content-Type: application/json" \
  -d '{
    "role": "string"
  }'

Update an organization user

POST
/organization/{slug}/remove

Post Organization Slug Remove

Remove a user from an organization

/organization/{slug}/remove

Request Body

application/jsonRequired

login
Required
string

User to remove

Path Parameters

slug
Required
string

Organization slug

curl -X POST "https://app.gitbutler.com/api/organization/string/remove" \
  -H "Content-Type: application/json" \
  -d '{
    "login": "string"
  }'

Remove a user from an organization

POST
/organization/{slug}/join

Post Organization Slug Join

Join an organization with an invite code

/organization/{slug}/join

Request Body

application/jsonRequired

invite_code
Required
string

Invite code

Path Parameters

slug
Required
string

Organization slug

curl -X POST "https://app.gitbutler.com/api/organization/string/join" \
  -H "Content-Type: application/json" \
  -d '{
    "invite_code": "string"
  }'

Join an organization with an invite code

POST
/organization

Post Organization

Create an organization

/organization

Request Body

application/jsonRequired

slug
Required
string

Organization slug

namestring

Organization name

descriptionstring

Description

curl -X POST "https://app.gitbutler.com/api/organization" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "string",
    "name": "string",
    "description": "string"
  }'

Create an organization