---
updatedAt: 2026-06-11T21:38:37.000Z
agentTools:
  projectIndex: https://docs.atono.io/llms.txt
---

# Add a user

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Atono API",
    "version": "0.1"
  },
  "servers": [
    {
      "url": "https://api.atono.io",
      "description": "Atono API"
    }
  ],
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "paths": {
    "/api/v1/users": {
      "post": {
        "tags": [
          "Users"
        ],
        "summary": "Add a user",
        "operationId": "createUser_1",
        "requestBody": {
          "description": "The user to add.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Request_UserCreateResourceV1_"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successfully added the user to the workspace.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SingleResourceBody_UserResourceV1_"
                }
              }
            },
            "links": {
              "self": {
                "operationId": "fetchUser",
                "parameters": {
                  "id": "$response.body#/data/id"
                }
              },
              "update": {
                "operationId": "updateUser",
                "parameters": {
                  "id": "$response.body#/data/id"
                }
              },
              "invite": {
                "operationId": "inviteUser",
                "parameters": {
                  "id": "$response.body#/data/id"
                }
              },
              "delete": {
                "operationId": "deleteUser",
                "parameters": {
                  "id": "$response.body#/data/id"
                }
              }
            }
          },
          "403": {
            "description": "The authenticated user does not have permission to add a new user.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NoResourceBody"
                }
              }
            }
          },
          "409": {
            "description": "The user already exists in the workspace.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NoResourceBody"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "NoResourceBody": {
        "properties": {
          "errors": {
            "type": "array",
            "description": "A list of errors returned with the response, if the request could not be completed. Each object includes details about a specific issue.",
            "items": {
              "$ref": "#/components/schemas/ProblemDetail",
              "description": "A problem detail object is a way to convey information about an error that occurred while processing a request."
            }
          },
          "meta": {
            "additionalProperties": true,
            "description": "Additional contextual information about the response. May include summary data such as item counts, timestamps, or other calculated values."
          },
          "included": {
            "type": "array",
            "description": "A list of related resources included in the response, either automatically by the API or in response to an include parameter in the request. Each item contains a full resource object (e.g., users, teams, acceptance criteria).",
            "items": {}
          },
          "links": {
            "additionalProperties": {
              "type": "string",
              "format": "uri"
            },
            "description": "Pagination or navigation links related to the response. May include keys such as `self`, `next`, `prev`, `first`, or `last`."
          }
        },
        "readOnly": true
      },
      "ProblemDetail": {
        "description": "A problem detail object is a way to convey information about an error that occurred while processing a request.",
        "properties": {
          "id": {
            "type": "string",
            "description": "A unique identifier for this specific error occurrence. Useful for debugging and support."
          },
          "links": {
            "additionalProperties": {
              "type": "string",
              "format": "uri"
            },
            "allOf": [
              {
                "type": [
                  "null",
                  "object"
                ]
              }
            ],
            "description": "Links related to the error. May include a URL to relevant documentation or support resources."
          },
          "status": {
            "type": "integer",
            "format": "int32",
            "description": "The HTTP status code associated with the error (e.g., 400, 404, 422)."
          },
          "code": {
            "type": "string",
            "description": "An internal code that identifies the type or category of the error."
          },
          "title": {
            "type": "string",
            "description": "A short summary of the problem."
          },
          "source": {
            "type": [
              "null",
              "object"
            ],
            "allOf": [
              {
                "$ref": "#/components/schemas/ProblemSource"
              }
            ],
            "readOnly": true
          },
          "detail": {
            "type": "string",
            "description": "Additional information about the error, intended to provide more context than the title."
          },
          "meta": {
            "additionalProperties": true,
            "description": "Additional information about the error, which may be useful for debugging. The contents vary depending on the error type."
          }
        },
        "readOnly": true
      },
      "ProblemSource": {
        "description": "Identifies the part of the request that caused the error. Only one source is present per error.",
        "properties": {
          "pointer": {
            "type": [
              "string",
              "null"
            ],
            "description": "Specifies the path to the field in the request body that caused the error."
          },
          "parameter": {
            "type": [
              "string",
              "null"
            ],
            "description": "Identifies a query parameter in the request URL that caused the error."
          },
          "header": {
            "type": [
              "string",
              "null"
            ],
            "description": "Identifies the request header that caused the error."
          }
        },
        "readOnly": true
      },
      "Request_UserCreateResourceV1_": {
        "properties": {
          "data": {
            "$ref": "#/components/schemas/UserCreateResourceV1"
          }
        },
        "required": [
          "data"
        ]
      },
      "SingleResourceBody_UserResourceV1_": {
        "properties": {
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UserResourceV1"
              }
            ],
            "description": "The returned resource, based on the request."
          },
          "errors": {
            "type": "array",
            "description": "A list of errors returned with the response, if the request could not be completed. Each object includes details about a specific issue.",
            "items": {
              "$ref": "#/components/schemas/ProblemDetail",
              "description": "A problem detail object is a way to convey information about an error that occurred while processing a request."
            }
          },
          "meta": {
            "additionalProperties": true,
            "description": "Additional contextual information about the response. May include summary data such as item counts, timestamps, or other calculated values."
          },
          "included": {
            "type": "array",
            "description": "A list of related resources included in the response, either automatically by the API or in response to an include parameter in the request. Each item contains a full resource object (e.g., users, teams, acceptance criteria).",
            "items": {}
          },
          "links": {
            "additionalProperties": {
              "type": "string",
              "format": "uri"
            },
            "description": "Pagination or navigation links related to the response. May include keys such as `self`, `next`, `prev`, `first`, or `last`."
          }
        },
        "readOnly": true
      },
      "UserCreateResourceV1": {
        "description": "A user is an individual with access to Atono, defined by a unique email address and optional profile details.",
        "properties": {
          "type": {
            "type": "string",
            "default": "user",
            "description": "Identifies the type of resource.",
            "pattern": "user",
            "defaultValue": "user",
            "requiredMode": "REQUIRED"
          },
          "attributes": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UserCreateResourceV1.Attributes"
              }
            ],
            "description": "Contains the structured data fields that describe the resource, such as properties, settings, and timestamps."
          }
        },
        "required": [
          "attributes",
          "type"
        ],
        "writeOnly": true
      },
      "UserCreateResourceV1.Attributes": {
        "description": "Contains the structured data fields that describe the resource, such as properties, settings, and timestamps.",
        "properties": {
          "email": {
            "type": "string",
            "format": "email",
            "description": "The user’s email address. Must be unique across all users.",
            "minLength": 1,
            "requiredMode": "REQUIRED"
          },
          "fullName": {
            "type": [
              "string",
              "null"
            ],
            "description": "The user’s full name, stored as a single field.",
            "requiredMode": "NOT_REQUIRED"
          }
        },
        "required": [
          "email"
        ]
      },
      "UserResourceV1": {
        "description": "A user is an individual with access to Atono, defined by a unique email address and optional profile details.",
        "properties": {
          "type": {
            "type": "string",
            "default": "user",
            "description": "Identifies the type of resource.",
            "pattern": "user",
            "defaultValue": "user"
          },
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "The unique identifier for the resource, typically a UUID."
          },
          "attributes": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UserResourceV1.Attributes"
              }
            ],
            "description": "Contains the structured data fields that describe the resource, such as properties, settings, and timestamps."
          }
        },
        "readOnly": true
      },
      "UserResourceV1.Attributes": {
        "description": "Contains the structured data fields that describe the resource, such as properties, settings, and timestamps.",
        "properties": {
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time the user account was created."
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time the user’s information (e.g., name, status, or roles) was last updated."
          },
          "invitedAt": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time the user was sent an invitation to join the workspace."
          },
          "email": {
            "type": "string",
            "format": "email",
            "description": "The user’s email address. Must be unique across all users."
          },
          "fullName": {
            "type": [
              "string",
              "null"
            ],
            "description": "The user’s full name, stored as a single field."
          },
          "deleted": {
            "type": "boolean",
            "description": "Indicates whether the user has been deleted."
          }
        }
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "name": "X-API-KEY",
        "in": "header"
      }
    }
  }
}
```