latestOpenAPI 3.1.02026-08-211061591.1 MB

69a962f1578f

Workspace

Update Logo

Upload an image to be used as the workspace logo. Similar to a user’s avatar. If delete is set to true, it removes the logo completely and does not return any logo_* attribute.

post/api/v1/workspaces/logo

Response

Successful Response

idstring required

String ID of the workspace.

namestring required

Workspace name.

descriptionstring required

Workspace description.

creator_idstring required

String ID of the user who created the workspace.

created_atstring date-time nullable required

Date and time when the workspace was created.

is_deletedboolean required

Whether the workspace is deleted.

is_collapsedboolean required

Whether the workspace is collapsed in the user's sidebar.

role'ADMIN' | 'MEMBER' | 'GUEST' required

Role of the user inside the workspace

plan'STARTER' | 'BUSINESS' required

The plan the workspace is currently on

pending_invitationsstring[] required

Emails with a pending invitation to the workspace. Only populated for workspace members.

is_link_sharing_enabledboolean nullable required

Whether joining the workspace via a link is enabled. null for non-members.

is_guest_allowedboolean required

Whether guests are allowed in the workspace.

is_trial_pendingboolean required

Whether the workspace is waiting for trial confirmation.

invite_codestring nullable required

Opaque code to invite users to the workspace, or null.

current_member_countinteger nullable required

Number of members in the workspace. null for non-members.

current_active_projectsinteger nullable required

Number of active projects in the workspace. null for non-members.

domain_namestring nullable required

Email domain associated with the workspace, or null.

domain_discoveryboolean required

Whether users with a matching email domain can discover the workspace.

restrict_email_domainsboolean required

Whether membership is restricted to allowed email domains.

admin_sorting_appliedboolean required

Whether an admin has applied custom project sorting.

user_sorting_appliedboolean required

Whether the current user has sorted their workspace sidebar before.

project_sort_preference'MANUAL' | 'A_TO_Z' | 'Z_TO_A' required

User preference for workspace project sorting

propertiesobject required

Additional workspace properties.

logo_s640string nullable

URL of the workspace logo (640px).

logo_bigstring nullable

URL of the workspace logo (195px).

logo_mediumstring nullable

URL of the workspace logo (60px).

logo_smallstring nullable

URL of the workspace logo (35px).

current_template_countinteger nullable

Number of active templates in the workspace. Only returned for workspace members.

pending_invites_by_typeobject nullable

Number of pending invitations by workspace role. Only returned for workspace members.

member_count_by_typeobject nullable

Number of members by workspace role. Only returned for workspace members.

Example response

{
  "id": "123456",
  "name": "Todoist",
  "description": "Team workspace",
  "creator_id": "1234567",
  "created_at": "2025-01-15T10:30:00Z",
  "pending_invitations": [
    "foo@example.com"
  ],
  "is_link_sharing_enabled": true,
  "is_guest_allowed": true,
  "invite_code": "abc123",
  "current_member_count": 5,
  "current_active_projects": 10,
  "domain_name": "doist.com",
  "current_template_count": 3,
  "pending_invites_by_type": {
    "admin_count": 0,
    "guest_count": 0,
    "member_count": 2
  },
  "member_count_by_type": {
    "admin_count": 1,
    "guest_count": 0,
    "member_count": 4
  }
}