<aside> 💡 If you’re only looking for tasks, you can use the tasks search API

Search tasks

</aside>

Endpoint: GET /search

Query parameters

• q string (required)

  Query: this will search through task names, descriptions, comments, user names, emails, and list names

Response

• combined Array of results

  A result can either be a task, a list, or an user.

  • Task

    {
      id: UUID,
    	resultType: 'task',
    	index: number,
    	name: string,
    	description: string,
    	status: string,
    	listIds: Array<UUID>,
    	trashedAt: Date | null,
    	redacted: 'deleted' | 'notPermitted' | null,
    	appearance: {
    		iconUrl: string,
    		hue: number | null,
    	},
    	comments: Array<{
    		activityId: UUID,
    		createdAt: Date,
    		createdUserId: UUID,
    		message: string,
    		highlight: {
    			message: Array<{
    				startOffset: number,
    				endOffset: number,
    			}>,
    		},
    	}>,
    }
    

  • List

    {
      id: UUID,
    	resultType: 'view',
    	name: string,
    	archivedAt: Date | null,
    	archivedBy: UUID | null,
    	key: string,
    	description: string,
    	type: 'smartlist' | 'list' | ...,
      userId: UUID | null,
    	restricted: boolean,
    	appearance: {
    		iconUrl: string,
    		hue: number | null,
    	}
    }
    

  • User

    {
      id: UUID,
    	resultType: 'user',
    	email: string,
    	firstname: string,
    	lastname: string,
    	username: string
    }