Projects

PreviousUsers NextAnalytics

Get project by ID

get

Retrieves a project by its ID

Authorizations

Path parameters

projectIdstring · uuidRequired

ID of the project to retrieve

Responses

200

Project details

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Resource not found

application/json

get

GET /v1/projects/{projectId} HTTP/1.1
Host: api.maisa.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174001",
    "name": "Website Redesign",
    "description": "Redesign of the company website",
    "status": "active",
    "createdAt": "2023-02-01T12:00:00Z",
    "ownerId": "123e4567-e89b-12d3-a456-426614174000",
    "members": [
      [
        {
          "userId": "123e4567-e89b-12d3-a456-426614174000",
          "role": "owner"
        },
        {
          "userId": "223e4567-e89b-12d3-a456-426614174000",
          "role": "editor"
        }
      ]
    ],
    "settings": {
      "visibility": "private",
      "enableComments": true
    },
    "updatedAt": "2023-02-15T10:00:00Z",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}

List all projects

get

Returns a list of all projects accessible to the authenticated user

Authorizations

Query parameters

limitinteger · min: 1 · max: 100Optional

Maximum number of projects to return

Default: 20

offsetintegerOptional

Number of projects to skip

Default: 0

statusstring · enumOptional

Filter projects by status

Possible values:

Responses

200

A list of projects

application/json

401

Unauthorized

application/json

get

GET /v1/projects HTTP/1.1
Host: api.maisa.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174001",
      "name": "Website Redesign",
      "description": "Redesign of the company website",
      "status": "active",
      "createdAt": "2023-02-01T12:00:00Z",
      "ownerId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "total": 100,
    "limit": 20,
    "offset": 0,
    "hasMore": true
  }
}

Create a new project

post

Creates a new project

Authorizations

Body

namestringRequiredExample: Website Redesign

descriptionstringOptionalExample: Redesign of the company website

statusstring · enumOptionalDefault: draftPossible values:

Responses

201

Project created successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

post

POST /v1/projects HTTP/1.1
Host: api.maisa.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 270

{
  "name": "Website Redesign",
  "description": "Redesign of the company website",
  "status": "draft",
  "members": [
    {
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "role": "editor"
    }
  ],
  "settings": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174001",
    "name": "Website Redesign",
    "description": "Redesign of the company website",
    "status": "active",
    "createdAt": "2023-02-01T12:00:00Z",
    "ownerId": "123e4567-e89b-12d3-a456-426614174000",
    "members": [
      [
        {
          "userId": "123e4567-e89b-12d3-a456-426614174000",
          "role": "owner"
        },
        {
          "userId": "223e4567-e89b-12d3-a456-426614174000",
          "role": "editor"
        }
      ]
    ],
    "settings": {
      "visibility": "private",
      "enableComments": true
    },
    "updatedAt": "2023-02-15T10:00:00Z",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}