Workspaces

A workspace can contain tasks or deals.

Retrieves a Workspace resource.

get

Retrieves a Workspace resource.

Authorizations

BearerAuthApiKeyAuth

Path parameters

idstringRequired

Workspace identifier

Responses

200

Workspace resource

application/ld+jsonapplication/json

@contextone ofOptional

stringOptional

or

@idstringRequired

@typestringRequired

idstring · nullableOptional

privacystring,null · enum · nullableRequiredPossible values:

titlestring · nullableRequired

descriptionstring · nullableOptional

ownerstring · nullableRequiredExample: https://example.com/

createdAtstring · nullableOptional

estimationboolean · nullableOptional

estimationTypestring · nullableOptional

currencystring · nullableOptional

archivedAtstring · nullableOptional

workspaceTypestring · nullableOptional

usersstring · iri-reference[]OptionalExample: ["/users/{id}"]

emojistring · nullableOptional

pinnedboolean · nullableOptional

isPrivateboolean · nullableOptional

totalAutomationsinteger · nullableOptional

columnsany ofOptional

or

columnOrderany ofWrite-onlyOptional

string · iri-reference[]OptionalExample: https://example.com/

or

string · iri-reference[]OptionalExample: https://example.com/

403

Forbidden

application/ld+jsonapplication/problem+jsonapplication/json

404

Not found

application/ld+jsonapplication/problem+jsonapplication/json

get/workspaces/{id}

HTTPcURLJavaScriptPython

GET /workspaces/{id} HTTP/1.1
Host: api.rogerroger.io
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,
  "currency": null,
  "archivedAt": null,
  "workspaceType": null,
  "users": [
    "/users/{id}"
  ],
  "emoji": null,
  "pinned": null,
  "isPrivate": null,
  "totalAutomations": null,
  "columns": [
    null
  ]
}

Retrieves the collection of Workspace resources.

get

Retrieves the collection of Workspace resources.

Authorizations

BearerAuthApiKeyAuth

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

totalItemsintegerOptional

403

Forbidden

application/ld+jsonapplication/problem+jsonapplication/json

get/workspaces

HTTPcURLJavaScriptPython

GET /workspaces HTTP/1.1
Host: api.rogerroger.io
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,
      "currency": null,
      "archivedAt": null,
      "workspaceType": null,
      "users": [
        "/users/{id}"
      ],
      "emoji": null,
      "pinned": null,
      "isPrivate": null,
      "totalAutomations": null,
      "columns": [
        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
      }
    ]
  }
}