Workspaces

A workspace can contain tasks or deals.

Retrieves a Workspace resource.

get

Retrieves a Workspace resource.

Authorizations

Path parameters

idstringRequired

Workspace identifier

Responses

200

Workspace resource

application/ld+jsonapplication/json

403

Forbidden

application/ld+jsonapplication/problem+jsonapplication/json

404

Not found

application/ld+jsonapplication/problem+jsonapplication/json

get

HTTPcURLJavaScriptPython

GET /workspaces/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "id": null,
  "privacy": "private",
  "title": null,
  "description": null,
  "owner": "https://example.com/",
  "createdAt": null,
  "estimation": null,
  "estimationType": null,
  "archivedAt": null,
  "users": [
    "/users/{id}"
  ],
  "emoji": null,
  "pinned": null,
  "isPrivate": null,
  "totalAutomations": null,
  "columns": [
    {
      "@context": "text",
      "@id": "text",
      "@type": "text",
      "id": null,
      "workspace": "https://example.com/",
      "title": null,
      "position": null,
      "color": null,
      "columnLimit": null,
      "behaviour": null
    }
  ]
}

Retrieves the collection of Workspace resources.

get

Retrieves the collection of Workspace resources.

Authorizations

Query parameters

pageintegerOptional

The collection page number

Default: 1

itemsPerPageinteger · max: 30Optional

The number of items per page

Default: 15

titlestringOptional

title[]string[]Optional

descriptionstringOptional

description[]string[]Optional

ownerstringOptional

owner[]string[]Optional

createdAt[before]stringOptional

createdAt[strictly_before]stringOptional

createdAt[after]stringOptional

createdAt[strictly_after]stringOptional

archivedAt[before]stringOptional

archivedAt[strictly_before]stringOptional

archivedAt[after]stringOptional

archivedAt[strictly_after]stringOptional

exists[archivedAt]booleanOptional

Responses

200

Workspace collection

application/ld+jsonapplication/json

403

Forbidden

application/ld+jsonapplication/problem+jsonapplication/json

get

HTTPcURLJavaScriptPython

GET /workspaces HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "member": [
    {
      "@context": "text",
      "@id": "text",
      "@type": "text",
      "id": null,
      "privacy": "private",
      "title": null,
      "description": null,
      "owner": "https://example.com/",
      "createdAt": null,
      "estimation": null,
      "estimationType": null,
      "archivedAt": null,
      "users": [
        "/users/{id}"
      ],
      "emoji": null,
      "pinned": null,
      "isPrivate": null,
      "totalAutomations": null,
      "columns": [
        {
          "@context": "text",
          "@id": "text",
          "@type": "text",
          "id": null,
          "workspace": "https://example.com/",
          "title": null,
          "position": null,
          "color": null,
          "columnLimit": null,
          "behaviour": null
        }
      ]
    }
  ],
  "totalItems": 1,
  "view": {
    "@id": "string",
    "type": "string",
    "first": "string",
    "last": "string",
    "previous": "string",
    "next": "string"
  },
  "search": {
    "@type": "text",
    "template": "text",
    "variableRepresentation": "text",
    "mapping": [
      {
        "@type": "text",
        "variable": "text",
        "property": null,
        "required": true
      }
    ]
  }
}