Project Search

Search for projects

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

See the search filtering documentation for details about the query syntax. The searchable attributes and the operators each one accepts are listed in the request body below.

Project-specific notes

  • status takes one of new_status, in_progress, deferred, cancelled, abandoned or done. New projects are returned with the status new, but search uses new_status:
    { "status": { "any": ["new_status", "in_progress"] } }
  • priority (0 to 10) and estimated_time (in seconds) are numbers and must be sent as JSON numbers:
    { "estimated_time": { "greater_than": 3600 } }
  • category matches by name, e.g. { "category": { "equal": "Internal" } }.
  • Contacts and companies take a search filter for that record type with any, so you can match by reference or by any of its attributes:
    { "contacts": { "any": { "contact": { "equal": "/v1/contacts/1000" } } } }
    { "companies": { "any": { "name": { "contains": "Acme" } } } }
  • opportunity (the opportunity the project was converted from) also takes an opportunity search filter, or blank / not_blank:
    { "opportunity": { "any": { "opportunity": { "equal": "/v1/opportunities/1000" } } } }
  • Linked records (appointments, notes, tasks, groups, forms, email_messages) work the same way, using the linked record's reference:
    { "tasks": { "any": { "task": { "equal": "/v1/tasks/1000" } } } }
  • role matches the name of a role a contact or company has on the project.
  • project and project_id match the project itself, by reference or by numeric ID.
Query Params
int32
≤ 250
Defaults to 50

Maximum number of results per page (max 250). Defaults to 50, or 10 when full-records is true.

boolean

Return every attribute of each result instead of the short list form.

int32

Return results whose ID is greater than or equal to this value. Use the next URL from the previous page rather than building this yourself.

Body Params
name
object

Example: Website Redesign

status
object

Project status. Search uses new_status for new projects (returned as new on records)

priority
object

Priority from 0 to 10

estimated_time
object

Estimated time in seconds

due
object

Due date

started
object

Start date

completed
object

Completion date

category
object

Category name, e.g. Internal

keywords
object

Keyword names, e.g. {"any": ["Web"]}

extra_fields
object

Filter on extra (custom) fields. Each operator takes an object keyed by the field's default identifier (even if it has been renamed), e.g. {"equal": {"com.marketcircle.daylite/extra1": {"value": "Gold"}}}. Several operators can be combined. Text operators (starts_with, contains, …) only work on text fields and range operators (less_than, greater_than, …) only on date fields.

contacts
object

Contacts with a role on the project. The operand is a contact search filter, e.g. {"any": {"contact": {"equal": "/v1/contacts/1000"}}}.

companies
object

Companies with a role on the project. The operand is a company search filter.

opportunity
object

The opportunity the project was converted from. The operand is an opportunity search filter, e.g. {"any": {"opportunity": {"equal": "/v1/opportunities/1000"}}}. Use blank or not_blank to find projects without or with one.

role
object

Name of a role a contact or company has on the project

appointments
object

Records linked to appointments. The operand is a search filter on appointments, for example {"any": {"appointment": {"equal": "/v1/appointments/1000"}}}.

notes
object

Records linked to notes. The operand is a search filter on notes, for example {"any": {"note": {"equal": "/v1/notes/1000"}}}.

tasks
object

Records linked to tasks. The operand is a search filter on tasks, for example {"any": {"task": {"equal": "/v1/tasks/1000"}}}.

groups
object

Records linked to groups. The operand is a search filter on groups, for example {"any": {"group": {"equal": "/v1/groups/1000"}}}.

forms
object

Records linked to forms. The operand is a search filter on forms, for example {"any": {"form": {"equal": "/v1/forms/1000"}}}.

email_messages
object

Records linked to emails. The operand is a search filter on emails, for example {"any": {"email_message": {"equal": "/v1/emails/1000"}}}.

project
object

The project itself, by reference, e.g. /v1/projects/1000

project_id
object

The project's numeric ID

owner
object

Owner reference, e.g. /v1/users/1000

creator
object

Creator reference, e.g. /v1/users/1000

create_date
object

Example: 2025-03-04T17:45:57.550Z

modify_date
object

Example: 2025-03-04T17:45:57.550Z

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json