API docs by Redocly

MetaCRUD2 API (1.0.0)

Download OpenAPI specification:Download

API for managing organizations and their data. This API is only accessible via the user interface and is authenticated via Auth0. The user email is the identifier for the user and the JWT included in the requests is used to validate the user identity with the Auth0 API for validation by the backend.

Get all organizations

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an organization

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string

Name of the organization

uuid
string

Optional UUID for the organization

Request samples

Content type
application/json
{
  • "name": "string",
  • "uuid": "string"
}

Get organization by UUID

Authorizations:
bearerAuth
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string"
}

Get all users

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get user by UUID

Authorizations:
bearerAuth
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "email": "string",
  • "first_name": "string",
  • "last_name": "string"
}

Get all users for an organization

Authorizations:
bearerAuth
path Parameters
uuid
required
string
query Parameters
role
string
Enum: "accountant" "administrator"

Add an existing user to an organization

Associates a user with an organization, allowing users to be members of multiple organizations

Authorizations:
bearerAuth
query Parameters
role
required
string
Enum: "accountant" "administrator"
Request Body schema: application/json
required
user_uuid
required
string

UUID of the existing user to add to this organization

Responses

Request samples

Content type
application/json
{
  • "user_uuid": "string"
}

Remove a user from an organization

Removes a user from an organization, disassociating the user from the organization in a specific role or in all roles if not specified

Authorizations:
bearerAuth
path Parameters
uuid
required
string
user_uuid
required
string
query Parameters
role
string
Enum: "accountant" "administrator"

Responses