Containers

List containers

GET /api/v1/containers

Parameters

Name	In	Type	Required	Description
`organisationId`	query	string	No	Organisation scope id; use `personal` for personal containers
`name`	query	string	No	Case-insensitive partial match on container name
`memberId`	query	string	No	Filter containers that include this member user id
`teamId`	query	string	No	Filter containers linked to this team id
`hasMembers`	query	boolean	No	—
`hasTeams`	query	boolean	No	—
`hasExternalLink`	query	boolean	No	—
`externalLinkProvider`	query	string	No	—
`createdAtEq`	query	number	No	—
`createdAtGte`	query	number	No	—
`createdAtLte`	query	number	No	—
`updatedAtEq`	query	number	No	—
`updatedAtGte`	query	number	No	—
`updatedAtLte`	query	number	No	—

Example request

curl -X GET \
"https://api.usemonoid.com/api/v1/containers?organisationId=<organisationId>&name=<name>&memberId=<memberId>&teamId=<teamId>&hasMembers=<hasMembers>&hasTeams=<hasTeams>&hasExternalLink=<hasExternalLink>&externalLinkProvider=<externalLinkProvider>&createdAtEq=<createdAtEq>&createdAtGte=<createdAtGte>&createdAtLte=<createdAtLte>&updatedAtEq=<updatedAtEq>&updatedAtGte=<updatedAtGte>&updatedAtLte=<updatedAtLte>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": [
    {
      "_id": "string",
      "userId": "string",
      "name": "string",
      "description": "string",
      "organisationId": "string",
      "links": [
        {}
      ],
      "updatedAt": 0
    }
  ]
}

Other statuses: 401, 403.

Response body type

{ data: Container[] }

Create container

POST /api/v1/containers

Example request

curl -X POST \
"https://api.usemonoid.com/api/v1/containers" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"
-d '{"name":"string","description":"string","organisationId":"string"}'

Example response

Status: 201

{
  "data": {
    "_id": "string",
    "userId": "string",
    "name": "string",
    "description": "string",
    "organisationId": "string",
    "links": [
      {
        "_id": "string",
        "userId": "string",
        "provider": "linear",
        "externalId": "string",
        "containerId": "string",
        "externalName": "string",
        "externalUrl": "string",
        "updatedAt": 0
      }
    ],
    "updatedAt": 0
  }
}

Other statuses: 400, 401, 402, 403, 500.

Response body type

{ data: Container }

Get container by id

GET /api/v1/containers/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Path parameter.
`includeLinks`	query	boolean	No	Include external links for the container.
`linkedProvider`	query	string (linear, notion, github, jira, wyrdos)	No	Optional provider filter for included external links.

Example request

curl -X GET \
"https://api.usemonoid.com/api/v1/containers/<id>?includeLinks=<includeLinks>&linkedProvider=<linkedProvider>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": {
    "_id": "string",
    "userId": "string",
    "name": "string",
    "description": "string",
    "organisationId": "string",
    "links": [
      {
        "_id": "string",
        "userId": "string",
        "provider": "linear",
        "externalId": "string",
        "containerId": "string",
        "externalName": "string",
        "externalUrl": "string",
        "updatedAt": 0
      }
    ],
    "updatedAt": 0
  }
}

Other statuses: 401, 403, 404.

Response body type

{ data: Container }

Update container

PATCH /api/v1/containers/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Path parameter.

Example request

curl -X PATCH \
"https://api.usemonoid.com/api/v1/containers/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"
-d '{"name":"string","description":"string"}'

Example response

Status: 200

{
  "data": {
    "_id": "string",
    "userId": "string",
    "name": "string",
    "description": "string",
    "organisationId": "string",
    "links": [
      {
        "_id": "string",
        "userId": "string",
        "provider": "linear",
        "externalId": "string",
        "containerId": "string",
        "externalName": "string",
        "externalUrl": "string",
        "updatedAt": 0
      }
    ],
    "updatedAt": 0
  }
}

Other statuses: 400, 401, 403, 404, 500.

Response body type

{ data: Container }

Delete container

DELETE /api/v1/containers/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Path parameter.

Example request

curl -X DELETE \
"https://api.usemonoid.com/api/v1/containers/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Other statuses: 401, 403, 404, 500.

Response body type

—

App Integrations

Containers