Sign in

v37

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-1170194628.0 KB
v1
User

Create User Batch

Create multiple users or link existing users to developer, and add each to the developer's workspace (if one exists).

post/v1/user/batch

Headers

X-API-Keystring required

Request body

Example request

{
  "users": [
    {
      "email": "user@example.com",
      "external_id": "user123",
      "metadata": {
        "name": "John Doe",
        "preferences": {
          "theme": "dark"
        }
      },
      "type": "developerUser"
    }
  ]
}

Response

Successful Response

codeinteger required

HTTP status code

statusstring required

'success' or 'error'

totalinteger nullable
pageinteger nullable
page_sizeinteger nullable
errorstring nullable
{"stackTrail":"components:schemas:UserListResponse:properties:details:anyOf","oasType":"schema","type":"unknown","title":"Details","nullable":true}

Example response

{
  "code": 200,
  "data": [
    {
      "created_at": "2024-03-20T10:00:00.000Z",
      "email": "user1@example.com",
      "external_id": "user123",
      "metadata": {
        "name": "John Doe",
        "preferences": {
          "theme": "dark"
        }
      },
      "updated_at": "2024-03-20T10:00:00.000Z",
      "user_id": "abc123"
    }
  ],
  "page": 1,
  "page_size": 10,
  "status": "success",
  "total": 1
}