Common Room

App · 20 actions

Read contacts, organizations, activity signals, segments, tags and custom fields.

Actions

ActionWhat it does
Api token status informationStatus information about the API token used in the request.
Get a contact by idRetrieve a specific contact by their unique identifier.
Get a custom field by idRetrieve a specific custom field definition by its unique identifier.
Get a lead score definition by idRetrieve a specific lead score definition by its unique identifier.
Get a location by idRetrieve a specific location by its unique identifier.
Get a segment by idRetrieve a specific segment by its unique identifier.
Get a tag by idRetrieve a specific tag by its unique identifier.
Get a topic by idRetrieve a specific topic by its unique identifier.
Get an activity by idRetrieve a specific activity by its unique identifier.
Get an organization by idRetrieve a specific organization by its unique identifier.
Get current user infoRetrieve information about the authenticated user, including their profile, bookmarked segments, personas, and company details.
List activitiesRetrieve a list of activities with pagination support.
List contactsRetrieve a list of contacts with pagination support.
List custom fieldsRetrieve all custom field definitions for the community, optionally filtered by entity type.
List lead score definitionsRetrieve all lead score definitions for the community.
List locationsRetrieve a paginated list of locations, sorted by member count (descending).
List organizationsRetrieve a list of organizations with pagination support.
List segmentsRetrieve a list of segments with pagination support.
List tagsRetrieve a list of tags (user-defined and auto-generated) for the community, with pagination support.
List topicsRetrieve a paginated list of topics, sorted alphabetically by name.

Api token status information

Status information about the API token used in the request.

Inputs

None.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "communityId": "example",
    "communityName": "example",
    "jti": "example"
  }
}

Get a contact by id

Retrieve a specific contact by their unique identifier.

Inputs

Idcontact_idtextRequired
The prefixed contact ID (format `c_ `)
Colscolstext
Comma-separated list of additional columns to include in the response. Valid values: `activateMessage`, `avatarUrl`, `fullName`, `location`, `primaryEmail`, `phoneNumbers`, `title`, `companyName`, `companyWebsite`, `linkedInUrls`, `gitHubUrls`, `xUrls`, `connectedCustomObjects`, `profiles`, `jobHistory`, `fullJobHistory`, `jobChangeDate`, `currentCompany`, `previousCompany`, `leadScores`, `leadScoreKeyFactors`, `recentActivities`, `recentWebPages`, `recentWebVisitsNumber`, `segments`, `sparkSummary`, `recentSparkSummaries`, `tags`, `url`, `activityCount7d`, `activityCount28d`, `activityCount8w`, `activityCount12w`, `activityCount6m`, `activityCount1y`, `activityCountAll`. Use `cf_*` to include all custom fields, or `cf_ ` for a specific one.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "activateMessage": {
        "message": "example",
        "title": "example"
      },
      "activityCount12w": 1,
      "activityCount1y": 1,
      "activityCount28d": 1,
      "activityCount6m": 1,
      "activityCount7d": 1,
      "activityCount8w": 1,
      "activityCountAll": 1,
      "avatarUrl": "example",
      "companyName": "example",
      "companyWebsite": "example",
      "connectedCustomObjects": [],
      "currentCompany": {
        "companyName": "example",
        "domain": "example",
        "employeeCount": 1,
        "endDate": "example",
        "industry": {
          "naicsCodes": [],
          "subIndustry": "example"
        },
        "isCurrent": false,
        "jobTitle": "example",
        "location": {
          "city": "example",
          "country": "example",
          "countryCode": "example",
          "region": "example"
        },
        "revenueRange": {
          "max": 1,
          "min": 1
        },
        "seniority": "example",
        "startDate": "example"
      },
      "customFields": {},
      "fullJobHistory": [],
      "fullName": "example",
      "gitHubUrls": [],
      "id": "example",
      "jobChangeDate": "example",
      "jobHistory": [],
      "leadScoreKeyFactors": [],
      "leadScores": [],
      "linkedInUrls": [],
      "location": {
        "city": "example",
        "country": "example",
        "countryCode": "example",
        "region": "example"
      },
      "name": "example",
      "phoneNumbers": [],
      "previousCompany": {
        "companyName": "example",
        "domain": "example",
        "employeeCount": 1,
        "endDate": "example",
        "industry": {
          "naicsCodes": [],
          "subIndustry": "example"
        },
        "isCurrent": false,
        "jobTitle": "example",
        "location": {
          "city": "example",
          "country": "example",
          "countryCode": "example",
          "region": "example"
        },
        "revenueRange": {
          "max": 1,
          "min": 1
        },
        "seniority": "example",
        "startDate": "example"
      },
      "primaryEmail": "example",
      "profiles": [],
      "recentActivities": [],
      "recentSparkSummaries": [],
      "recentWebPages": [],
      "recentWebVisitsNumber": 1,
      "segments": [],
      "sparkSummary": "example",
      "tags": [],
      "title": "example",
      "url": "example",
      "xUrls": []
    },
    "success": true
  }
}

Get a custom field by id

Retrieve a specific custom field definition by its unique identifier.

Inputs

Idcustom_field_idtextRequired
The prefixed custom field ID (format `cf_ `)

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "description": "example",
      "entityTypes": [],
      "id": "example",
      "keyField": false,
      "name": "example",
      "objectTypeId": "example",
      "providedBy": "example",
      "sampleValues": [],
      "targetSubTypes": [],
      "valueType": "string"
    },
    "success": true
  }
}

Get a lead score definition by id

Retrieve a specific lead score definition by its unique identifier.

Inputs

Idlead_score_idtextRequired
The prefixed lead score ID (format `ls_ `)

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "enabled": false,
      "entityType": "contact",
      "id": "example",
      "isPrimaryScore": false,
      "name": "example",
      "outputType": "percentile"
    },
    "success": true
  }
}

Get a location by id

Retrieve a specific location by its unique identifier.

Inputs

Idlocation_idtextRequired
The prefixed location ID

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "city": "example",
      "country": "example",
      "id": "example",
      "name": "example",
      "region": "example",
      "type": "city"
    },
    "success": true
  }
}

Get a segment by id

Retrieve a specific segment by its unique identifier.

Inputs

Idsegment_idtextRequired
The prefixed segment ID (format `s_ `)
Colscolstext
Comma-separated list of additional columns to include in the response. Valid values: `entityCount`, `url`, `summary`, `automationStatus`.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "automationStatus": "paused",
      "entityCount": 1,
      "entityType": "contact",
      "id": "example",
      "name": "example",
      "summary": "example",
      "url": "example"
    },
    "success": true
  }
}

Get a tag by id

Retrieve a specific tag by its unique identifier.

Inputs

Idtag_idtextRequired
The prefixed tag ID (format `l_ `)

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "description": "example",
      "entityTypes": [],
      "id": "example",
      "name": "example",
      "objectTypeId": "example"
    },
    "success": true
  }
}

Get a topic by id

Retrieve a specific topic by its unique identifier.

Inputs

Idtopic_idtextRequired
The prefixed topic ID (format `tp_ `)

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "id": "example",
      "name": "example"
    },
    "success": true
  }
}

Get an activity by id

Retrieve a specific activity by its unique identifier.

Inputs

Idactivitie_idtextRequired
The prefixed activity ID (format `a_ `)
Colscolstext
Comma-separated list of additional columns to include in the response. Valid values: `contactId`, `content`, `isUserInitiated`, `participantCount`, `providerId`, `providerName`, `replyCount`, `sentiment`, `subSourceNames`, `url`.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "activityTime": "example",
      "contactId": "example",
      "content": "example",
      "id": "example",
      "isUserInitiated": false,
      "participantCount": 1,
      "providerId": "example",
      "providerName": "example",
      "replyCount": 1,
      "sentiment": "example",
      "subSourceNames": [],
      "type": "example",
      "url": "example"
    },
    "success": true
  }
}

Get an organization by id

Retrieve a specific organization by its unique identifier.

Inputs

Idorganization_idtextRequired
The prefixed organization ID (format `o_ `)
Colscolstext
Comma-separated list of additional columns to include in the response. Valid values: `about`, `contactsCount`, `employees`, `linkedInUrl`, `profiles`, `revenueRangeMax`, `revenueRangeMin`, `subIndustry`, `technologies`, `location`, `leadScores`, `leadScoreKeyFactors`, `recentJobOpenings`, `recentNews`, `researchResults`, `surgingTopics`, `tags`, `topContacts`, `url`. Use `cf_*` to include all custom fields, or `cf_ ` for a specific one.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "about": "example",
      "contactsCount": 1,
      "customFields": {},
      "employees": 1,
      "id": "example",
      "leadScoreKeyFactors": [],
      "leadScores": [],
      "linkedInUrl": "example",
      "location": {
        "city": "example",
        "country": "example",
        "countryCode": "example",
        "region": "example"
      },
      "name": "example",
      "primaryDomain": "example",
      "profiles": [],
      "recentJobOpenings": [],
      "recentNews": [],
      "researchResults": [],
      "revenueRangeMax": 1,
      "revenueRangeMin": 1,
      "subIndustry": "example",
      "surgingTopics": [],
      "tags": [],
      "technologies": [],
      "topContacts": [],
      "url": "example"
    },
    "success": true
  }
}

Get current user info

Retrieve information about the authenticated user, including their profile, bookmarked segments, personas, and company details.

Inputs

None.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "communityId": "example",
      "company": {
        "domains": [],
        "name": "example",
        "summary": "example"
      },
      "id": "example",
      "loginEmail": "example",
      "name": "example",
      "personas": [],
      "profiles": [],
      "role": "example",
      "segments": [],
      "title": "example"
    },
    "success": true
  }
}

List activities

Retrieve a list of activities with pagination support.

Inputs

Limitlimitnumber
The maximum number of activities to return per pageFrom 1 to 1000.
Cursorcursortext
Pagination cursor from a previous response
Sortsorttext
Field to sort results by.One of: id, activityTime.
Directiondirectiontext
Sort directionOne of: asc, desc.
Colscolstext
Comma-separated list of additional columns to include in the response. Valid column values: `contactId`, `content`, `isUserInitiated`, `participantCount`, `providerId`, `providerName`, `replyCount`, `sentiment`, `subSourceNames`, `url`. The meta column `recordCount` can be requested to return the total number of matching activities in `meta.recordCount`.
Contactcontact_idtext
Filter activities by prefixed contact ID (format `c_ `)
Organizationorganization_idtext
Filter activities by prefixed organization ID (format `o_ `)
Start datestart_datedate and time
Only return activities occurring at or after this ISO-8601 datetime
End dateend_datedate and time
Only return activities occurring at or before this ISO-8601 datetime
Light filterlight_filtertext
Structured filter as URL-encoded JSON : see the `LightFilterExpression` schema for the grammar. Conditions are combined (AND) with the other query parameters. To filter by contact or organization, use the dedicated `contactId` / `organizationId` query parameters above. Filterable fields: | Field | Filter type | Operators | Description | |---|---|---|---| | `activityTime` | `dateRangeFilter` | `in`, `between`, `after`, `before` | Filter activities by time range | | `activityType` | `stringListFilter` | `any`, `none` | Filter activities by activity type ID. Use PascalCase enum names returned in activity records (e.g., "SlackPost", "GitHubIssueOpen"). | | `activityProviderId` | `stringListFilter` | `any`, `none` | Filter activities by provider ID. Use provider IDs from `GET /providers` to discover available sources (e.g., Gong, Salesforce, Slack). | | `activityTopic` | `stringListFilter` | `any`, `all`, `none`, `empty`, `notEmpty` | Filter activities by topic IDs. Use `GET /topics` to list available topics. | | `activityKeyword` | `stringListFilter` | `any`, `all`, `none` | Keyword search across activity content | | `activityCategory` | `stringListFilter` | `any`, `all`, `none`, `empty`, `notEmpty` | Filter activities by auto-category label IDs. Use `GET /activity-categories` to find IDs. | | `activitySentiment` | `stringListFilter` | `any`, `all`, `none`, `empty`, `notEmpty` | Filter activities by sentiment label IDs. Use `GET /activity-sentiment` to find IDs. | | `activityIsParent` | `booleanFilter` | `eq`, `ne` | Filter activities by whether they are parent activities (conversations) | | `activityIsUserInitiated` | `booleanFilter` | `eq`, `ne` | Filter activities by whether they were initiated by the contact. | | `activityIsTeamMember` | `booleanFilter` | `eq`, `ne` | Filter activities by whether the contact who performed them is a teammate (workspace user). | Filtering by a related entity: a group whose `target` names another entity applies its clauses to that entity, using the fields of that entity's list endpoint. Every group must send `target`, `objectConfigId` and `targetAssocPaths`, using `null` for any it doesn't use. Targets this endpoint accepts: | Target | Matches activities | Clauses use | |---|---|---| | Contact (alias `Member`) | whose contact matches | `GET /contacts` fields | | Organization (alias `Company`) | whose organization matches | `GET /organizations` fields | Any other target, including `Object`, returns a 400.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "meta": {
      "nextCursor": "example",
      "recordCount": 1
    },
    "success": true
  }
}

List contacts

Retrieve a list of contacts with pagination support.

Inputs

Limitlimitnumber
The maximum number of contacts to return per pageFrom 1 to 1000.
Cursorcursortext
Pagination cursor from a previous response
Sortsorttext
Field to sort results by. One of: `id`, `latest_activity`, `name`, a lead-score ID (format `ls_ `), a custom-field ID (format `cf_ `), or an activity-count sort: `activity_count_7d`, `activity_count_28d`, `activity_count_8w`, `activity_count_12w`, `activity_count_6m`, `activity_count_1y`, `activity_count_all`. Activity-count sorts rank contacts by number of activities in that trailing window; use `direction=desc` and request the matching `activityCount*` column to see the counts.One of: id, latest_activity (Latest activity), name, activity_count_7d (Activity count 7d), activity_count_28d (Activity count 28d), activity_count_8w (Activity count 8w), activity_count_12w (Activity count 12w), activity_count_6m (Activity count 6m), activity_count_1y (Activity count 1y), activity_count_all (Activity count all).
Directiondirectiontext
Sort directionOne of: asc, desc.
Colscolstext
Comma-separated list of additional columns to include in the response. Valid column values: `activateMessage`, `avatarUrl`, `fullName`, `location`, `primaryEmail`, `phoneNumbers`, `title`, `companyName`, `companyWebsite`, `linkedInUrls`, `gitHubUrls`, `xUrls`, `connectedCustomObjects`, `profiles`, `jobHistory`, `fullJobHistory`, `jobChangeDate`, `currentCompany`, `previousCompany`, `leadScores`, `leadScoreKeyFactors`, `recentActivities`, `recentWebPages`, `recentWebVisitsNumber`, `segments`, `sparkSummary`, `recentSparkSummaries`, `tags`, `url`, `activityCount7d`, `activityCount28d`, `activityCount8w`, `activityCount12w`, `activityCount6m`, `activityCount1y`, `activityCountAll`. Use `cf_*` to include all custom fields, or `cf_ ` for a specific one. The meta column `recordCount` can be requested to return the total number of matching contacts in `meta.recordCount`.
Organizationorganization_idtext
Filter contacts by prefixed organization ID (format `o_ `)
Segmentsegment_idtext
Filter contacts by segment ID (e.g. s_123456)
Light filterlight_filtertext
Structured filter as URL-encoded JSON : see the `LightFilterExpression` schema for the grammar. Conditions are combined (AND) with the other query parameters. Filterable fields: | Field | Filter type | Operators | Description | |---|---|---|---| | `memberHasEmail` | `booleanFilter` | `eq`, `ne` | Filter contacts by whether they have an email address. | | `isTeamMember` | `booleanFilter` | `eq`, `ne` | Filter contacts by whether they are a teammate (workspace user). | | `memberHasPrimaryEmail` | `booleanFilter` | `eq`, `ne` | Filter contacts by whether they have a primary email. | | `memberHasPrimaryBusinessEmail` | `booleanFilter` | `eq`, `ne` | Filter contacts by whether they have a primary business email. | | `memberHasPhoneNumber` | `booleanFilter` | `eq`, `ne` | Filter contacts by whether they have a phone number. | | `memberHasPrimaryPhoneNumber` | `booleanFilter` | `eq`, `ne` | Filter contacts by whether they have a primary phone number. | | `memberHasPremiumPhoneNumber` | `booleanFilter` | `eq`, `ne` | Filter contacts by whether they have a premium phone number. | | `memberRole` | `stringListFilter` | `any`, `none` | Filter contacts by job role : case-insensitive free text matched against the contact's stored role (e.g. "Software Engineer", "VP of Sales"), not a fixed category list. Discover the role values present in this workspace via `GET /member-roles` (most common roles, ranked by contact count). For normalized seniority buckets use memberSeniority. | | `memberSeniority` | `stringListFilter` | `any`, `none` | Filter contacts by normalized job seniority. Valid values: Intern, Junior IC, Senior IC, Manager, Director, VP, C-Level. | | `memberEmail` | `stringFilter` | `eq`, `like` | Filter contacts by email. Pass a full address ("needshelp@acme.com") for exact case-insensitive lookup, or a domain ("acme.com" / "@acme.com") to match anyone on that domain. | | `memberEmailDomain` | `stringListFilter` | `any`, `none` | Filter contacts by email domain. Performs exact domain matching : "mail.com" will not match "gmail.com". Pass one or more domains without the "@" prefix (e.g., ["acme.com", "example.org"]). | | `companyName` | `stringFilter` | `eq`, `like` | Filter contacts by their company/organization name (e.g., "Acme Corp"). | | `companyWebsite` | `stringFilter` | `eq`, `like` | Filter contacts by their company/organization website domain (e.g., "acme.com"). | | `fullName` | `stringFilter` | `eq`, `like` | Filter contacts by name | | `title` | `stringFilter` | `eq`, `like`, `empty`, `notEmpty` | Filter contacts by job title; `empty`/`notEmpty` (with a null value) match contacts without or with any title. | | `memberSegmentId` | `stringListFilter` | `any`, `all`, `none` | Filter by segment (play) membership. Use segment IDs from `GET /segments`. | | `groupId` | `stringListFilter` | `any`, `none` | Filter by organization membership. Use organization IDs from `GET /organizations`. | | `memberLabelId` | `stringListFilter` | `any`, `all`, `none` | Filter contacts by tag/label ID(s). Use tag IDs from `GET /tags` (e.g., "l_131504"). | | `locationId` | `stringListFilter` | `any`, `none` | Filter contacts by location ID(s). Use location IDs from `GET /locations`. | | `memberLeadScorePercentile` | `leadScoreFilter` | `eq`, `ne`, `gt`, `gte`, `lt`, `lte` | Filter contacts by lead score percentile (0-100). Requires a scoreId from `GET /lead-scores`. | | `ls_*` | `numberFilter` | `eq`, `ne`, `gt`, `gte`, `lt`, `lte` | Filter contacts by a Point Value lead score's raw point total, using the score ID as the field name. May be negative or fractional. Only scores whose `outputType` is `point_value` match; use `memberLeadScorePercentile` for percentile scores. | | `memberWebVisitLastSeen` | `dateRangeFilter` | `in`, `between`, `after`, `before` | Filter contacts by when they last visited the website. | | `memberWebVisitFirstSeen` | `dateRangeFilter` | `in`, `between`, `after`, `before` | Filter contacts by when they first visited the website. | | `memberWebVisitPageViews` | `numberFilter` | `eq`, `ne`, `gt`, `gte`, `lt`, `lte` | Filter contacts by total tracked web page-view count (all-time). | | `memberWebVisitPagesViewed` | `webVisitPages` | `any`, `none` | Filter contacts by which web pages they visited within a window. Provide page URL patterns, an interval (ISO 8601 duration, e.g. "P30D"), and optional minimum page views. | | `memberLastActivity` | `dateRangeFilter` | `in`, `between`, `after`, `before` | Filter contacts by when they were last active. | | `memberJobChangedAt` | `dateRangeFilter` | `in`, `between`, `after`, `before` | Filter contacts by when they changed jobs (started at a new company). Prefer a window with op `in` and an ISO 8601 duration (e.g. "P90D" for the last 90 days). Job changes are typically detected within a few months of the change taking place. | | `cf_*` | `stringFilter` | varies by field type | Filter by custom field value. Use the custom field ID (e.g., "cf_123456") as the field name. Find field IDs and their types via `GET /custom-fields`. Supports stringFilter for text fields, stringListFilter for enum/dropdown fields, numberFilter for numeric fields, booleanFilter for checkbox fields, and dateRangeFilter for date fields. | Filtering by a related entity: a group whose `target` names another entity applies its clauses to that entity, using the fields of that entity's list endpoint. Every group must send `target`, `objectConfigId` and `targetAssocPaths`, using `null` for any it doesn't use. Targets this endpoint accepts: | Target | Matches contacts | Clauses use | |---|---|---| | Contact (alias `Member`) | that match the clauses, the same as no target | the fields above | | Organization (alias `Company`) | whose organization matches | `GET /organizations` fields | | Object | associated with a matching custom object; set `objectConfigId` to its type (`cot_ `) | `GET /objects` fields | | Activity | with at least one matching activity | `GET /activities` fields | Any other target returns a 400.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "meta": {
      "nextCursor": "example",
      "recordCount": 1
    },
    "success": true
  }
}

List custom fields

Retrieve all custom field definitions for the community, optionally filtered by entity type.

Inputs

Entity typeentity_typetext
Filter fields by entity type. Valid values: `contact`, `organization`, or a prefixed object type ID (format `cot_ `).

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "success": true
  }
}

List lead score definitions

Retrieve all lead score definitions for the community.

Inputs

None.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "success": true
  }
}

List locations

Retrieve a paginated list of locations, sorted by member count (descending).

Inputs

Location typelocation_typetextRequired
The granularity of locations to return (required)One of: city, country, country_region (Country region), world_region (World region).
Limitlimitnumber
The maximum number of locations to return per pageFrom 1 to 1000.
Cursorcursortext
Pagination cursor from a previous response
Colscolstext
Comma-separated list of meta columns. The meta column `recordCount` can be requested to return the total number of matching locations in `meta.recordCount`.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "meta": {
      "nextCursor": "example",
      "recordCount": 1
    },
    "success": true
  }
}

List organizations

Retrieve a list of organizations with pagination support.

Inputs

Limitlimitnumber
The maximum number of organizations to return per pageFrom 1 to 1000.
Cursorcursortext
Pagination cursor from a previous response
Sortsorttext
Field to sort results by. One of: `id`, `member_count`, a lead-score ID (format `ls_ `), or a custom-field ID (format `cf_ `).
Directiondirectiontext
Sort directionOne of: asc, desc.
Colscolstext
Comma-separated list of additional columns to include in the response. Valid column values: `about`, `contactsCount`, `employees`, `linkedInUrl`, `profiles`, `revenueRangeMax`, `revenueRangeMin`, `subIndustry`, `technologies`, `location`, `leadScores`, `leadScoreKeyFactors`, `recentJobOpenings`, `recentNews`, `researchResults`, `surgingTopics`, `tags`, `topContacts`, `url`. Use `cf_*` to include all custom fields, or `cf_ ` for a specific one. The meta column `recordCount` can be requested to return the total number of matching organizations in `meta.recordCount`.
Namenametext
Filter organizations by exact name match
Primary domainprimary_domaintext
Filter organizations by primary domain (exact match)
Light filterlight_filtertext
Structured filter as URL-encoded JSON : see the `LightFilterExpression` schema for the grammar. Conditions are combined (AND) with the other query parameters. Filterable fields: | Field | Filter type | Operators | Description | |---|---|---|---| | `companyName` | `stringFilter` | `eq`, `like` | Filter organizations by name. | | `companyWebsite` | `stringFilter` | `eq`, `like` | Filter organizations by website domain (e.g., "acme.com"). | | `groupSegmentId` | `stringListFilter` | `any`, `all`, `none` | Filter organizations by segment membership. Use segment IDs from `GET /segments`. | | `groupLabelId` | `stringListFilter` | `any`, `all`, `none` | Filter organizations by tag/label ID(s). Use tag IDs from `GET /tags` (e.g., "l_131504"). | | `groupLocationId` | `stringListFilter` | `any`, `none` | Filter organizations by location ID(s). Use location IDs from `GET /locations`. | | `groupSubIndustry` | `stringListFilter` | `any`, `all`, `none` | Filter organizations by industry label (e.g. "Software", "Financial Services"). | | `groupMemberCount` | `numberFilter` | `eq`, `ne`, `gt`, `gte`, `lt`, `lte` | Filter organizations by number of members | | `groupRevenue` | `numberFilter` | `gt`, `gte`, `lt`, `lte` | Filter organizations by estimated annual revenue. Lower bounds match the estimate's floor, upper bounds its ceiling. | | `groupCompanySize` | `numberFilter` | `eq`, `ne`, `gt`, `gte`, `lt`, `lte` | Filter organizations by company size (number of employees) | | `groupLeadScorePercentile` | `leadScoreFilter` | `eq`, `ne`, `gt`, `gte`, `lt`, `lte` | Filter organizations by lead score percentile (0-100). Requires a scoreId from `GET /lead-scores`. | | `ls_*` | `numberFilter` | `eq`, `ne`, `gt`, `gte`, `lt`, `lte` | Filter organizations by a Point Value lead score's raw point total, using the score ID as the field name. May be negative or fractional. Only scores whose `outputType` is `point_value` match; use `groupLeadScorePercentile` for percentile scores. | | `groupWebVisitLastSeen` | `dateRangeFilter` | `in`, `between`, `after`, `before` | Filter organizations by when anyone from the org last visited the website. | | `groupWebVisitFirstSeen` | `dateRangeFilter` | `in`, `between`, `after`, `before` | Filter organizations by when anyone from the org first visited the website. | | `groupWebVisitPageViews` | `numberFilter` | `eq`, `ne`, `gt`, `gte`, `lt`, `lte` | Filter organizations by total tracked web page-view count (all-time). | | `groupWebVisitPagesViewed` | `webVisitPages` | `any`, `none` | Filter organizations by which web pages were visited within a window. Provide page URL patterns, an interval (ISO 8601 duration, e.g. "P30D"), and optional minimum page views. | | `groupNaicsCode` | `stringListFilter` | `any`, `none` | Filter organizations by NAICS industry code(s). Values are numeric string codes (e.g. "517", "5112"). Discover codes via `GET /industries`. For industry labels instead, use groupSubIndustry. | | `groupTechStackId` | `stringListFilter` | `any`, `all`, `none` | Filter organizations by tech stack product ID(s). Use product IDs from `GET /tech-stack-products`. | | `surgingTopics` | `stringListFilter` | `any`, `none`, `notEmpty` | Filter organizations by Bombora surging topic name(s) : research topics the org is showing buying intent on (e.g. "Customer Data Platform", "Marketing Automation"). Pass topic names, not IDs; `notEmpty` (with a null value) matches organizations surging on any topic. | | `cf_*` | `stringFilter` | varies by field type | Filter by custom field value. Use the custom field ID (e.g., "cf_3166091") as the field name. Find field IDs and their types via `GET /custom-fields`. Supports stringFilter for text fields, stringListFilter for enum/dropdown fields, numberFilter for numeric fields, booleanFilter for checkbox fields, and dateRangeFilter for date fields. | Filtering by a related entity: a group whose `target` names another entity applies its clauses to that entity, using the fields of that entity's list endpoint. Every group must send `target`, `objectConfigId` and `targetAssocPaths`, using `null` for any it doesn't use. Targets this endpoint accepts: | Target | Matches organizations | Clauses use | |---|---|---| | Organization (alias `Company`) | that match the clauses, the same as no target | the fields above | | Contact (alias `Member`) | with at least one matching contact | `GET /contacts` fields | | Object | associated with a matching custom object; set `objectConfigId` to its type (`cot_ `) | `GET /objects` fields | | JobOpening | with a matching job posting (see below) | `GET /job-openings` fields | | NewsItem | with at least one matching news item | `GET /news-items` fields | Any other target returns a 400. `JobOpening` and `NewsItem` groups need `null` for both `objectConfigId` and `targetAssocPaths`. A clause using the `none` operator in one of them must be the group's only clause, and a `JobOpening` group does not accept `jobOpeningLastSeen`. Job postings are matched in groups: an organization's postings that share status, seniority and first-seen day are stored together. Status, seniority and first-seen clauses therefore hold for the same posting, while title, keyword and location clauses can be met by different postings in that group.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "meta": {
      "nextCursor": "example",
      "recordCount": 1
    },
    "success": true
  }
}

List segments

Retrieve a list of segments with pagination support.

Inputs

Limitlimitnumber
The maximum number of segments to return per pageFrom 1 to 1000.
Cursorcursortext
Pagination cursor from a previous response
Colscolstext
Comma-separated list of additional columns to include in the response. Valid column values: `entityCount`, `url`, `summary`, `automationStatus`. The meta column `recordCount` can be requested to return the total number of matching segments in `meta.recordCount`.
Querysearch_querytext
Filter segments by name (substring match)

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "meta": {
      "nextCursor": "example",
      "recordCount": 1
    },
    "success": true
  }
}

List tags

Retrieve a list of tags (user-defined and auto-generated) for the community, with pagination support.

Inputs

Limitlimitnumber
The maximum number of tags to return per pageFrom 1 to 1000.
Cursorcursortext
Pagination cursor from a previous response
Querysearch_querytext
Filter tags by a case-insensitive substring of their name
Entity typeentity_typetext
Filter tags by the type of entity they can be applied toOne of: contact, organization, activity, object.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "meta": {
      "nextCursor": "example"
    },
    "success": true
  }
}

List topics

Retrieve a paginated list of topics, sorted alphabetically by name.

Inputs

Limitlimitnumber
The maximum number of topics to return per pageFrom 1 to 1000.
Cursorcursortext
Pagination cursor from a previous response
Querysearch_querytext
Filter topics by display name prefix
Colscolstext
Comma-separated list of meta columns. The meta column `recordCount` can be requested to return the total number of matching topics in `meta.recordCount`.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "meta": {
      "nextCursor": "example",
      "recordCount": 1
    },
    "success": true
  }
}

On this page