Group Search

post

https://api.marketcircle.net/v1/groups/_search

Search for groups

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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.

Group-specific notes

Linked records (appointments, contacts, companies, opportunities, projects, tasks, notes, forms, email_messages) take a search filter for that record type with any, using the linked record's reference:
{ "contacts": { "any": { "contact": { "equal": "/v1/contacts/1000" } } } }
extra_fields works as described in search filtering, e.g. { "extra_fields": { "equal": { "com.marketcircle.daylite/extra1": { "value": "Email" } } } }.
category matches by name.
group and group_id match the group itself, by reference or by numeric ID.

Subgroups, parent groups, priority, start and end can't be searched.

Query Params

limit

int32

≤ 250

Defaults to 50

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

full-records

boolean

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

start

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: Spring Campaign

details

object

Details text

category

object

Category name

keywords

object

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

extra_fields

object

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

appointments

object

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

contacts

object

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

companies

object

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

opportunities

object

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

projects

object

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

tasks

object

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

notes

object

Records linked to notes. The operand is a search filter on notes, for example {"any": {"note": {"equal": "/v1/notes/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"}}}.

group

object

The group itself, by reference, e.g. /v1/groups/1000

group_id

object

The group'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: {"greater_than": "2025-03-04T17:45:57Z"}

modify_date

object

Example: {"greater_than": "2025-03-04T17:45:57Z"}

Responses

Group-specific notes

200200 OK

400400 Bad Request