GitButler Logo

User

Operations about users

GET
/user

Get User

Return my user

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

Return my user

{
  "id": "string",
  "login": "string",
  "name": "string",
  "email": "string",
  "avatar_url": "string",
  "given_name": "string",
  "family_name": "string",
  "picture": "string",
  "locale": "string",
  "supporter": "string",
  "organizations": {
    "slug": "string",
    "name": "string",
    "description": "string",
    "created_at": "string"
  },
  "created_at": "string",
  "updated_at": "string",
  "access_token": "string",
  "role": "string",
  "projects": {
    "slug": "string",
    "owner": "string",
    "parent_project": {},
    "name": "string",
    "description": "string",
    "repository_id": "string",
    "code_repository_id": "string",
    "active_reviews_count": 0,
    "permissions": {
      "can_read": "string",
      "can_write": "string",
      "share_level": "string"
    },
    "created_at": "string",
    "updated_at": "string"
  }
}

PUT
/user

Put User

Update my user

/user

Request Body

application/jsonRequired

namestring

User name

avatarstring

Avatar binary file

localestring

Language locale (en, de)

given_namestring

Given name

family_namestring

Family name

curl -X PUT "https://app.gitbutler.com/api/user" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "avatar": "string",
    "locale": "string",
    "given_name": "string",
    "family_name": "string"
  }'

Update my user

{
  "id": "string",
  "login": "string",
  "name": "string",
  "email": "string",
  "avatar_url": "string",
  "given_name": "string",
  "family_name": "string",
  "picture": "string",
  "locale": "string",
  "supporter": "string",
  "organizations": {
    "slug": "string",
    "name": "string",
    "description": "string",
    "created_at": "string"
  },
  "created_at": "string",
  "updated_at": "string",
  "access_token": "string",
  "role": "string",
  "projects": {
    "slug": "string",
    "owner": "string",
    "parent_project": {},
    "name": "string",
    "description": "string",
    "repository_id": "string",
    "code_repository_id": "string",
    "active_reviews_count": 0,
    "permissions": {
      "can_read": "string",
      "can_write": "string",
      "share_level": "string"
    },
    "created_at": "string",
    "updated_at": "string"
  }
}

POST
/user/keys

Post User Keys

Create SSH Public Key

/user/keys

Request Body

application/jsonRequired

name
Required
string

Key name

public_key
Required
string

Public key

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

Create SSH Public Key

DELETE
/user/keys

Delete User Keys

Delete SSH Public Key

/user/keys

Query Parameters

fingerprint
Required
string

Key fingerprint

curl -X DELETE "https://app.gitbutler.com/api/user/keys?fingerprint=string"

Delete SSH Public Key

GET
/user/{login}

Get User Login

Return a user

/user/{login}

Path Parameters

login
Required
string

User login

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

Return a user

{
  "id": "string",
  "login": "string",
  "name": "string",
  "email": "string",
  "avatar_url": "string",
  "given_name": "string",
  "family_name": "string",
  "picture": "string",
  "locale": "string",
  "supporter": "string",
  "organizations": {
    "slug": "string",
    "name": "string",
    "description": "string",
    "created_at": "string"
  },
  "created_at": "string",
  "updated_at": "string"
}

GET
/user/{login}/keys

Get User Login Keys

List a users SSH public keys

/user/{login}/keys

Path Parameters

login
Required
string

User login

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

List a users SSH public keys