Search

Global search

Search across tasks, projects, workspaces, comments, and activities in one workspace. Results are ranked by relevance and returned as a single flat list, each entry tagged with its type.

get/search

Query parameters

qstring required
type'all' | 'tasks' | 'projects' | 'workspaces' | 'comments' | 'activities'
workspaceIdstring required
projectIdstring
limitstring
userEmailstring email

Response

Ranked search results

totalCountnumber required

Total matches found before the limit slice, so a caller can tell that more exist.

searchQuerystring required

The query that was run.

Changes

Changed in 12 of the 23 revisions of this API.983881

  • 08bbb5bedb5d357See the full diff
    • the query request parameter workspaceId became required

      request-parameter-became-required

    • for the query request parameter limit, default value was changed from 20 to 20

      request-parameter-default-value-changed

    • for the query request parameter workspaceId, the minLength was increased from 0 to 1

      request-parameter-min-length-increased

    • removed the optional property activities from the response with the 200 status

      response-optional-property-removed

    • removed the optional property comments from the response with the 200 status

      response-optional-property-removed

    • removed the optional property projects from the response with the 200 status

      response-optional-property-removed

    • removed the optional property tasks from the response with the 200 status

      response-optional-property-removed

    • removed the optional property workspaces from the response with the 200 status

      response-optional-property-removed

    • for the query request parameter limit, the type/format was generalized from integer/ to string/

      request-parameter-type-generalized

    • added the non-success response with the status 400

      response-non-success-status-added

    • added the non-success response with the status 401

      response-non-success-status-added

    • added the non-success response with the status 403

      response-non-success-status-added

    • added the required property results to the response with the 200 status

      response-required-property-added

    • added the required property searchQuery to the response with the 200 status

      response-required-property-added

    • added the required property totalCount to the response with the 200 status

      response-required-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • for the query request parameter limit, default value was changed from 20 to 20

      request-parameter-default-value-changed

    • for the query request parameter limit, the type/format was changed from string/ to integer/

      request-parameter-type-changed

  • 32cece1ebe4395See the full diff
    • the activities/items/createdAt response's property type/format changed from / to string/date-time for status 200

      response-property-type-changed

    • the activities/items/type response's property type/format changed from / to string/ for status 200

      response-property-type-changed

    • the comments/items/createdAt response's property type/format changed from / to string/date-time for status 200

      response-property-type-changed

    • the comments/items/type response's property type/format changed from / to string/ for status 200

      response-property-type-changed

    • the projects/items/createdAt response's property type/format changed from / to string/date-time for status 200

      response-property-type-changed

    • the tasks/items/createdAt response's property type/format changed from / to string/date-time for status 200

      response-property-type-changed

    • the tasks/items/dueDate response's property type/format changed from / to string/date-time for status 200

      response-property-type-changed

    • the tasks/items/priority response's property type/format changed from / to string/ for status 200

      response-property-type-changed

    • the workspaces/items/createdAt response's property type/format changed from / to string/date-time for status 200

      response-property-type-changed

    • for the query request parameter type, the type/format was generalized from / to string/

      request-parameter-type-generalized

    • added the optional property tasks/items/startDate to the response with the 200 status

      response-optional-property-added

    • added the required property activities/items/eventData to the response with the 200 status

      response-required-property-added

    • added the required property comments/items/eventData to the response with the 200 status

      response-required-property-added

    • added the required property projects/items/archivedAt to the response with the 200 status

      response-required-property-added

  • c45ef22a736c2222See the full diff
    • the response property activities/items/content became nullable for the status 200

      response-property-became-nullable

    • the response property activities/items/externalSource became nullable for the status 200

      response-property-became-nullable

    • the response property activities/items/externalUrl became nullable for the status 200

      response-property-became-nullable

    • the response property activities/items/externalUserAvatar became nullable for the status 200

      response-property-became-nullable

    • the response property activities/items/externalUserName became nullable for the status 200

      response-property-became-nullable

    • the response property activities/items/userId became nullable for the status 200

      response-property-became-nullable

    • the response property comments/items/content became nullable for the status 200

      response-property-became-nullable

    • the response property comments/items/externalSource became nullable for the status 200

      response-property-became-nullable

    • the response property comments/items/externalUrl became nullable for the status 200

      response-property-became-nullable

    • the response property comments/items/externalUserAvatar became nullable for the status 200

      response-property-became-nullable

    • the response property comments/items/externalUserName became nullable for the status 200

      response-property-became-nullable

    • the response property comments/items/userId became nullable for the status 200

      response-property-became-nullable

    • the response property projects/items/description became nullable for the status 200

      response-property-became-nullable

    • the response property projects/items/icon became nullable for the status 200

      response-property-became-nullable

    • the response property projects/items/isPublic became nullable for the status 200

      response-property-became-nullable

    • the response property tasks/items/description became nullable for the status 200

      response-property-became-nullable

    • the response property tasks/items/number became nullable for the status 200

      response-property-became-nullable

    • the response property tasks/items/position became nullable for the status 200

      response-property-became-nullable

    • the response property tasks/items/userId became nullable for the status 200

      response-property-became-nullable

    • the response property workspaces/items/description became nullable for the status 200

      response-property-became-nullable

    • the response property workspaces/items/logo became nullable for the status 200

      response-property-became-nullable

    • the response property workspaces/items/metadata became nullable for the status 200

      response-property-became-nullable

    • response property activities/items/content list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property activities/items/externalSource list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property activities/items/externalUrl list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property activities/items/externalUserAvatar list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property activities/items/externalUserName list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property activities/items/userId list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property comments/items/content list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property comments/items/externalSource list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property comments/items/externalUrl list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property comments/items/externalUserAvatar list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property comments/items/externalUserName list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property comments/items/userId list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property projects/items/description list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property projects/items/icon list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property projects/items/isPublic list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property tasks/items/description list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property tasks/items/number list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property tasks/items/position list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property tasks/items/userId list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property workspaces/items/description list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property workspaces/items/logo list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property workspaces/items/metadata list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

  • 298877d6a79a262See the full diff
    • for the query request parameter limit, default value was changed from 20 to 20

      request-parameter-default-value-changed

    • response property activities/items/content list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property activities/items/externalSource list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property activities/items/externalUrl list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property activities/items/externalUserAvatar list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property activities/items/externalUserName list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property activities/items/userId list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property comments/items/content list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property comments/items/externalSource list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property comments/items/externalUrl list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property comments/items/externalUserAvatar list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property comments/items/externalUserName list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property comments/items/userId list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property projects/items/description list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property projects/items/icon list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property projects/items/isPublic list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property tasks/items/description list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property tasks/items/number list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property tasks/items/position list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property tasks/items/userId list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property workspaces/items/description list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property workspaces/items/logo list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property workspaces/items/metadata list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • the activities/items/type response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • the comments/items/type response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • the tasks/items/priority response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • for the query request parameter limit, the type/format was generalized from integer/ to string/

      request-parameter-type-generalized

    • for the query request parameter type, the type/format was generalized from string/ to /

      request-parameter-type-generalized

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4b8811b821e62523See the full diff
    • the response property activities/items/content became nullable for the status 200

      response-property-became-nullable

    • the response property activities/items/externalSource became nullable for the status 200

      response-property-became-nullable

    • the response property activities/items/externalUrl became nullable for the status 200

      response-property-became-nullable

    • the response property activities/items/externalUserAvatar became nullable for the status 200

      response-property-became-nullable

    • the response property activities/items/externalUserName became nullable for the status 200

      response-property-became-nullable

    • the response property activities/items/userId became nullable for the status 200

      response-property-became-nullable

    • the response property comments/items/content became nullable for the status 200

      response-property-became-nullable

    • the response property comments/items/externalSource became nullable for the status 200

      response-property-became-nullable

    • the response property comments/items/externalUrl became nullable for the status 200

      response-property-became-nullable

    • the response property comments/items/externalUserAvatar became nullable for the status 200

      response-property-became-nullable

    • the response property comments/items/externalUserName became nullable for the status 200

      response-property-became-nullable

    • the response property comments/items/userId became nullable for the status 200

      response-property-became-nullable

    • the response property projects/items/description became nullable for the status 200

      response-property-became-nullable

    • the response property projects/items/icon became nullable for the status 200

      response-property-became-nullable

    • the response property projects/items/isPublic became nullable for the status 200

      response-property-became-nullable

    • the response property tasks/items/description became nullable for the status 200

      response-property-became-nullable

    • the response property tasks/items/number became nullable for the status 200

      response-property-became-nullable

    • the response property tasks/items/position became nullable for the status 200

      response-property-became-nullable

    • the response property tasks/items/userId became nullable for the status 200

      response-property-became-nullable

    • the response property workspaces/items/description became nullable for the status 200

      response-property-became-nullable

    • the response property workspaces/items/logo became nullable for the status 200

      response-property-became-nullable

    • the response property workspaces/items/metadata became nullable for the status 200

      response-property-became-nullable

    • the activities/items/type response's property type/format changed from / to string/ for status 200

      response-property-type-changed

    • the comments/items/type response's property type/format changed from / to string/ for status 200

      response-property-type-changed

    • the tasks/items/priority response's property type/format changed from / to string/ for status 200

      response-property-type-changed

    • for the query request parameter type, the type/format was generalized from / to string/

      request-parameter-type-generalized

    • response property activities/items/content list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property activities/items/externalSource list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property activities/items/externalUrl list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property activities/items/externalUserAvatar list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property activities/items/externalUserName list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property activities/items/userId list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property comments/items/content list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property comments/items/externalSource list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property comments/items/externalUrl list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property comments/items/externalUserAvatar list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property comments/items/externalUserName list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property comments/items/userId list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property projects/items/description list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property projects/items/icon list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property projects/items/isPublic list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property tasks/items/description list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property tasks/items/number list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property tasks/items/position list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property tasks/items/userId list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property workspaces/items/description list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property workspaces/items/logo list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property workspaces/items/metadata list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • for the query request parameter limit, default value was changed from 20 to 20

      request-parameter-default-value-changed

    • for the query request parameter limit, the type/format was changed from string/ to integer/

      request-parameter-type-changed

  • 3a866dc9932616See the full diff
    • the tasks/items/status response's property type/format changed from / to string/ for status 200

      response-property-type-changed

    • removed the archived enum value from the tasks/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the done enum value from the tasks/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the in-progress enum value from the tasks/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the in-review enum value from the tasks/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the planned enum value from the tasks/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the to-do enum value from the tasks/items/status response property for the response status 200

      response-property-enum-value-removed

  • f6c7baa3692439See the full diff
    • the response property tasks/items/dueDate became optional for the status 200

      response-property-became-optional

    • response property activities/items/userId list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property comments/items/userId list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • removed subschema #1 subschema #2 from the tasks/items/dueDate response property anyOf list for the response status 200

      response-property-any-of-removed

    • added the required property activities/items/externalSource to the response with the 200 status

      response-required-property-added

    • added the required property activities/items/externalUrl to the response with the 200 status

      response-required-property-added

    • added the required property activities/items/externalUserAvatar to the response with the 200 status

      response-required-property-added

    • added the required property activities/items/externalUserName to the response with the 200 status

      response-required-property-added

    • added the required property comments/items/externalSource to the response with the 200 status

      response-required-property-added

    • added the required property comments/items/externalUrl to the response with the 200 status

      response-required-property-added

    • added the required property comments/items/externalUserAvatar to the response with the 200 status

      response-required-property-added

    • added the required property comments/items/externalUserName to the response with the 200 status

      response-required-property-added

  • 38f83a691e6a3311See the full diff
    • the activities/items/type response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • the comments/items/type response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • the tasks/items/status response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • added the new archived enum value to the tasks/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new assignee_changed enum value to the activities/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new assignee_changed enum value to the comments/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new comment enum value to the activities/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new comment enum value to the comments/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new create enum value to the activities/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new create enum value to the comments/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new description_changed enum value to the activities/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new description_changed enum value to the comments/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new done enum value to the tasks/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new due_date_changed enum value to the activities/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new due_date_changed enum value to the comments/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new high enum value to the tasks/items/priority response property for the response status 200

      response-property-enum-value-added

    • added the new in-progress enum value to the tasks/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new in-review enum value to the tasks/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new low enum value to the tasks/items/priority response property for the response status 200

      response-property-enum-value-added

    • added the new medium enum value to the tasks/items/priority response property for the response status 200

      response-property-enum-value-added

    • added the new no-priority enum value to the tasks/items/priority response property for the response status 200

      response-property-enum-value-added

    • added the new planned enum value to the tasks/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new priority_changed enum value to the activities/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new priority_changed enum value to the comments/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new status_changed enum value to the activities/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new status_changed enum value to the comments/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new task enum value to the activities/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new task enum value to the comments/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new title_changed enum value to the activities/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new title_changed enum value to the comments/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new to-do enum value to the tasks/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new unassigned enum value to the activities/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new unassigned enum value to the comments/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new urgent enum value to the tasks/items/priority response property for the response status 200

      response-property-enum-value-added

    • removed subschema #1 subschema #2 from the tasks/items/priority response property anyOf list for the response status 200

      response-property-any-of-removed