Search accounts

POST 
/accounts/_search

Search accounts by name and/or domain. If both are specified, it will perform an AND operation. Support:

Provider	Search By
Apollo	name only
Salesloft	name, domain
Outreach	name, domain

Note: only read_from_cache=false is supported at the moment.

Request

Query Parameters

include_raw_data boolean
Whether to include raw data fetched from the 3rd party provider.
Example: true
page_size string
Number of results to return per page. (Max: 1000)
Example: 123
cursor string
The pagination cursor value
Example: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
read_from_cache boolean
Whether to read from Supaglue's Managed Destination cache or to read directly from the provider.
NOTE: read_from_cache=true requires you to have the object synced to the Supaglue Managed Destination.
Example: true

Header Parameters

x-customer-id stringrequired
The customer ID that uniquely identifies the customer in your application
Example: my-customer-1
x-provider-name stringrequired
The provider name
Example: salesforce

application/json

Body

required

filter objectrequired

The criteria to upsert on. If both name and domain are specified, it would perform an AND operation. If more than one account is found that matches, then an error will be thrown.

name string

The name of the account to upsert on. Supported for Outreach, Salesloft, and Apollo.

domain string

The domain of the account to upsert on. Only supported for Outreach and Salesloft.

Responses

200

Paginated accounts

application/json

Schema

Schema

pagination objectrequired
next stringnullablerequired
previous stringnullablerequired
total_count number
records object[]required
Array [
id stringrequired
owner_id stringnullablerequired
name stringnullablerequired
domain stringnullablerequired
created_at date-timenullablerequired
updated_at date-timenullablerequired
is_deleted booleanrequired
last_modified_at date-timerequired
raw_data object
property name* any
]

Example (from schema)

{
  "pagination": {
    "next": "eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ==",
    "previous": "eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9",
    "total_count": 100
  },
  "records": [
    {
      "id": 54312,
      "owner_id": "23e640fe-6105-4a11-a636-3aa6b6c6e762",
      "name": "My Company",
      "domain": "mycompany.com",
      "created_at": "2022-02-27T00:00:00Z",
      "updated_at": "2022-02-27T00:00:00Z",
      "is_deleted": false,
      "last_modified_at": "2022-02-27T00:00:00Z",
      "raw_data": {}
    }
  ]
}

Loading...