Logo
Teamflow Logo

Teamflow APIs

Teamflow is a virtual office where teams can work, meet and hang out together. It combines video, open spaces, meeting rooms, and tools like docs, whiteboards, video, and images to create a collaborative work space that feels better than working in the office.

Developer

Teamflow APIs

Account Request URL

-

Base Endpoint

-

GetArchivedWorkspaces

Gets a list of all archived workspaces.

GET

/api/v1/teamflow/workspaces/archived

GetAdminSettings

Retrieves the admin settings for the organization.

GET

/api/v1/teamflow/settings/admin

GetAPIUsage

Gets monthly API usage summary for the workspace.

GET

/api/v1/teamflow/usage

GetCollaborators

Fetches all the collaborators in a workspace.

GET

/api/v1/teamflow/workspaces/{workspace_id}/collaborators

GetComment

Gets a single comment.

GET

/api/v1/teamflow/comments/{comment_id}

GetComments

Fetches all the comments in a workspace.

GET

/api/v1/teamflow/workspaces/{workspace_id}/comments

GetCompany

Retrieves a company.

GET

/api/v1/teamflow/companies/{company_id}

GetCompanyAddress

Retrieves the company address.

GET

/api/v1/teamflow/companies/{company_id}/address

GetCompanyEmployees

Retrieves all the employees in a company.

GET

/api/v1/teamflow/companies/{company_id}/employees

GetCompanySettings

Retrieves the company settings.

GET

/api/v1/teamflow/settings/company/{company_id}

GetConversation

Returns a conversation.

GET

/api/v1/teamflow/conversations/{conversation_id}

GetConversations

Fetches all the conversations in a workspace.

GET

/api/v1/teamflow/workspaces/{workspace_id}/conversations

GetCurrentUser

Get information about the current user.

GET

/api/v1/teamflow/user

GetFlow

Gets a flow by its identifier.

GET

/api/v1/teamflow/flows/{flow_id}

GetFlowByIdentifier

Gets a flow by its identifier.

GET

/api/v1/teamflow/workspaces/{workspace_id}/flows/{flow_identifier}

GetFlowRunHistory

Gets the run history of a flow.

GET

/api/v1/teamflow/flows/{flow_id}/runs

GetFlowRunHistoryItem

Gets the details of a single run of a flow.

GET

/api/v1/teamflow/flows/{flow_id}/runs/{run_id}

GetFlows

Fetches all the flows in a workspace.

GET

/api/v1/teamflow/workspaces/{workspace_id}/flows

GetImportantMessage

Fetches the important message for all users in a workspace.

GET

/api/v1/teamflow/workspaces/{workspace_id}/messages/important

GetMessage

Gets a single message.

GET

/api/v1/teamflow/messages/{message_id}

GetMessages

Fetches all the messages in a workspace.

GET

/api/v1/teamflow/workspaces/{workspace_id}/messages

GetMyMessages

Fetches all the messages sent by the current user.

GET

/api/v1/teamflow/messages/mine

GetMyProfile

Returns the profile of the current user.

GET

/api/v1/teamflow/user/profile

GetMyTasks

Fetches all the tasks assigned to the current user.

GET

/api/v1/teamflow/tasks/mine

GetNotificationSettings

Retrieves the notification settings for the organization.

GET

/api/v1/teamflow/settings/notifications

GetOrganization

Retrieves an organization.

GET

/api/v1/teamflow/organizations/{organization_id}

GetOrganizationUsers

Retrieves all the users in an organization.

GET

/api/v1/teamflow/organizations/{organization_id}/users

GetProfile

Returns the profile of a user.

GET

/api/v1/teamflow/users/{user_id}/profile

GetProfiles

Returns the profiles of multiple users.

GET

/api/v1/teamflow/profiles

GetRunLogs

Get logs for a flow run.

GET

/api/v1/teamflow/flows/{flow_id}/runs/{run_id}/logs

GetTask

Gets a task by its identifier.

GET

/api/v1/teamflow/tasks/{task_id}

GetTaskCollaborators

Fetches all the collaborators of a task.

GET

/api/v1/teamflow/tasks/{task_id}/collaborators

GetTaskComments

Fetches all the comments of a task.

GET

/api/v1/teamflow/tasks/{task_id}/comments

GetTaskHistory

Gets the history of a task.

GET

/api/v1/teamflow/tasks/{task_id}/history

GetTasks

Fetches all the tasks in a workspace.

GET

/api/v1/teamflow/workspaces/{workspace_id}/tasks

GetUser

Retrieves a user.

GET

/api/v1/teamflow/users/{user_id}

GetUsers

Fetches all the users in a workspace.

GET

/api/v1/teamflow/workspaces/{workspace_id}/users

GetWorkspace

Gets a workspace by its identifier.

GET

/api/v1/teamflow/workspaces/{workspace_id}

GetWorkspaceAddress

Retrieves the workspace address.

GET

/api/v1/teamflow/workspaces/{workspace_id}/address

GetWorkspaceCompany

Retrieves the company associated with the workspace.

GET

/api/v1/teamflow/workspaces/{workspace_id}/company

GetWorkspaceMemberships

Returns a list of all workspace memberships for the current user.

GET

/api/v1/teamflow/memberships

GetWorkspaceSettings

Retrieves the workspace settings.

GET

/api/v1/teamflow/settings/workspace/{workspace_id}

InitiateFlow

Initiates a flow.

POST

/api/v1/teamflow/flows/{flow_identifier}/initiate

comment, input_values

PinComment

Pins a comment.

POST

/api/v1/teamflow/comments/{comment_id}/pin

PinMessage

Pins a message.

POST

/api/v1/teamflow/messages/{message_id}/pin

PostComment

Creates a new comment on a task.

POST

/api/v1/teamflow/tasks/{task_id}/comments

comment, input_values

PostMessage

Creates a new message in a workspace.

POST

/api/v1/teamflow/workspaces/{workspace_id}/messages

attachments, content, private_to

SendMessage

Creates a new message and sends it to one or more users.

POST

/api/v1/teamflow/messages

attachments, content, private_to, to

SoftDeleteComment

Soft deletes a comment.

POST

/api/v1/teamflow/comments/{comment_id}/delete

SoftDeleteFlow

Soft deletes a flow

POST

which marks it as deleted but retains the data.

/api/v1/teamflow/flows/{flow_id}/delete

SoftDeleteMessage

Soft deletes a message

POST

which marks it as deleted but retains the data.

/api/v1/teamflow/messages/{message_id}/delete

SoftDeleteTask

Soft deletes a task

POST

which marks it as deleted but retains the data.

/api/v1/teamflow/tasks/{task_id}/delete

UnPinMessage

Unpins a message.

POST

/api/v1/teamflow/messages/{message_id}/unpin

UpdateAPIUsage

Updates the API usage.

PUT

/api/v1/teamflow/usage

monthly_usage

UpdateComment

Updates a comment.

PUT

/api/v1/teamflow/comments/{comment_id}

comment

UpdateCompany

Updates a company.

PUT

/api/v1/teamflow/companies/{company_id}

address, company_description, company_domain, company_name, company_taxid, finance_contact, finance_email, industry, parent_company_id, payment_terms, registration_number, registration_type, share_class, social_media_links, stock_symbol, ticker_symbol, total_employees, verified, website

UpdateCompanyAddress

Updates the business address of the company.

PUT

/api/v1/teamflow/companies/{company_id}/address

address_line_1, address_line_2, city, country, state, zip_code

UpdateCompanyEmployees

Updates the employees of the company.

PUT

/api/v1/teamflow/companies/{company_id}/employees

employees

UpdateFlow

Updates a flow.

PUT

/api/v1/teamflow/flows/{flow_id}

description, flow_name, flow_type, icon

UpdateFlowRunStatus

Updates the status of a flow run.

PUT

/api/v1/teamflow/flows/{flow_id}/runs/{run_id}

status

UpdateMessage

Updates a message.

PUT

/api/v1/teamflow/messages/{message_id}

content

UpdateOrganization

Updates an organization

PUT

address|name|verified

UpdateProfile

Updates a user's profile.

PUT

/api

Details

Provider

Country HQ

API Type

REST

Categories

Virtual Office

Alternatives

Important URLs

Last Updated on

2024-04-04

Created At

2023-12-14

Other Apps

Upskill for a better future

Want to start tracking API at scale?

Get updates about your favorite APIs and SDKs

Contact Us

We do our best to ensure that the data we release is complete, accurate, and useful. However, because we are not able to verify all the data, and because the processing required to make the data useful is complex, we cannot be held liable for omissions or inaccuracies.

ApiRefs Logo