Users

Create Users Api

Users API endpoint performs a LinearB users creation.

post/api/v1/users

Request

Base URL
https://public-api.linearb.io
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/linearb/apis/linearb-api/docs/api/v1/users/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring required

username must be at least 3 characters long, start with a letter

emailstring required

User's email address

Example request

[
  {
    "name": "ada lovelace",
    "email": "ada@lovelace.io",
    "permission": {
      "team_scopes": [
        "All Teams"
      ]
    },
    "team_membership": [
      {
        "name": "Ada engineering",
        "joined_at": "2025-01-01"
      }
    ],
    "custom_info": {
      "extra_emails": [
        "user@lovelace.io"
      ],
      "extra_ids": [
        "1234567890"
      ]
    }
  }
]

Response

Successful Response

Changes

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