---
updatedAt: 2026-05-26T09:37:32.000Z
agentTools:
  projectIndex: https://developers.livestorm.co/llms.txt
---

# Create a user

Create a new team member user.

> 📘 This endpoint requires the `admin:write` scope.

<HTMLBlock>{`
<style>
  /* open all API sections in the page */
  .subpages { display: block!important; }
</style>
`}</HTMLBlock>

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Livestorm - Public API",
    "description": "Welcome to Livestorm's Public API documentation.\nThe Livestorm API is organized around REST principles.\nIn addition, all request and response bodies, including errors, are encoded in JSON format.\n",
    "termsOfService": "https://livestorm.co/terms/",
    "contact": {
      "name": "Contact",
      "url": "https://support.livestorm.co",
      "email": "help@livestorm.co"
    },
    "version": "1"
  },
  "servers": [
    {
      "url": "https://{defaultHost}",
      "variables": {
        "defaultHost": {
          "default": "api.localhost/v1"
        }
      }
    }
  ],
  "components": {
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      },
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "/oauth/authorize",
            "tokenUrl": "/oauth/token",
            "scopes": {
              "full:read": "Grants read access",
              "full:write": "Grants write access"
            }
          }
        }
      }
    },
    "schemas": {
      "BaseResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "ID"
          },
          "type": {
            "type": "string",
            "description": "Type"
          }
        }
      }
    }
  },
  "paths": {
    "/users": {
      "post": {
        "summary": "Create a user",
        "tags": [
          "Users"
        ],
        "description": "Create a new team member user.",
        "security": [
          {
            "api_key": []
          },
          {
            "oauth2": []
          }
        ],
        "parameters": [],
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "allOf": [
                        {
                          "$ref": "#/components/schemas/BaseResponse"
                        },
                        {
                          "type": "object",
                          "description": "Data",
                          "properties": {
                            "attributes": {
                              "type": "object",
                              "description": "Attributes",
                              "properties": {
                                "role": {
                                  "type": "string",
                                  "x-nullable": false,
                                  "description": ""
                                },
                                "created_at": {
                                  "type": "integer",
                                  "x-nullable": true,
                                  "description": ""
                                },
                                "updated_at": {
                                  "type": "integer",
                                  "x-nullable": true,
                                  "description": ""
                                },
                                "timezone": {
                                  "type": "string",
                                  "x-nullable": true,
                                  "description": ""
                                },
                                "first_name": {
                                  "type": "string",
                                  "x-nullable": true,
                                  "description": ""
                                },
                                "last_name": {
                                  "type": "string",
                                  "x-nullable": true,
                                  "description": ""
                                },
                                "email": {
                                  "type": "string",
                                  "x-nullable": true,
                                  "description": ""
                                },
                                "avatar_link": {
                                  "type": "string",
                                  "x-nullable": true,
                                  "description": ""
                                },
                                "locale": {
                                  "type": "string",
                                  "x-nullable": true,
                                  "description": ""
                                },
                                "pending_invite": {
                                  "type": "boolean",
                                  "x-nullable": true,
                                  "description": ""
                                },
                                "website_link": {
                                  "type": "string",
                                  "x-nullable": true,
                                  "description": ""
                                },
                                "linkedin_link": {
                                  "type": "string",
                                  "x-nullable": true,
                                  "description": ""
                                },
                                "facebook_link": {
                                  "type": "string",
                                  "x-nullable": true,
                                  "description": ""
                                },
                                "twitter_handle": {
                                  "type": "string",
                                  "x-nullable": true,
                                  "description": ""
                                }
                              }
                            }
                          }
                        }
                      ]
                    }
                  },
                  "required": [
                    "data"
                  ]
                },
                "examples": {
                  "application/vnd.api+json": {
                    "value": {
                      "data": {
                        "id": "d31cc036-b443-4486-8de9-2c830a15dbaa",
                        "type": "users",
                        "attributes": {
                          "role": "moderator",
                          "created_at": 1779785682,
                          "updated_at": 1779785682,
                          "first_name": null,
                          "last_name": null,
                          "email": "jean-baptiste@mysite.co",
                          "avatar_link": null,
                          "locale": "en",
                          "workspace_role": "member",
                          "account_id": "05ca1438-3b17-48d1-abe5-40b4ec133c7c",
                          "pending_invite": true,
                          "website_link": null,
                          "linkedin_link": null,
                          "facebook_link": null,
                          "twitter_handle": null
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request, role is required",
            "content": {}
          },
          "401": {
            "description": "Authentication failed",
            "content": {}
          },
          "403": {
            "description": "Workspace blocked",
            "content": {}
          },
          "422": {
            "description": "Unprocessable entity, max limit reached",
            "content": {}
          },
          "429": {
            "description": "Too Many Requests",
            "content": {},
            "headers": {
              "RateLimit-Interval-Limit": {
                "schema": {
                  "type": "integer"
                },
                "description": "The number of allowed requests for the current period (1 second)"
              },
              "RateLimit-Interval-Remaining": {
                "schema": {
                  "type": "integer"
                },
                "description": "The number of remaining requests for the current period (1 second)"
              },
              "Retry-After": {
                "schema": {
                  "type": "integer"
                },
                "description": "The number of seconds you are required to wait before the next successful request"
              },
              "RateLimit-Reset": {
                "schema": {
                  "type": "integer"
                },
                "description": "A timestamp of when the limit will be reset"
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/vnd.api+json": {
              "schema": {
                "type": "object",
                "properties": {
                  "data": {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": "string",
                        "default": "users",
                        "example": "users"
                      },
                      "attributes": {
                        "type": "object",
                        "properties": {
                          "email": {
                            "type": "string",
                            "x-nullable": true,
                            "description": "",
                            "example": "jean-baptiste@mysite.co"
                          },
                          "role": {
                            "type": "string",
                            "x-nullable": true,
                            "description": "",
                            "enum": [
                              "host",
                              "moderator"
                            ],
                            "example": "moderator"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```