Skip to main content
GET
/
v1
/
snoozed-contacts
cURL
curl --request GET \
  --url https://client-api.salesfinity.co/v1/snoozed-contacts \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "_id": "<string>",
      "team": "<string>",
      "phone_number": "<string>",
      "snooze_until": "2023-11-07T05:31:56Z",
      "user": {
        "_id": "<string>",
        "email": "<string>",
        "first_name": "<string>",
        "last_name": "<string>"
      },
      "contact_list": "<string>",
      "linkedin_username": "<string>",
      "external_contact_id": "<string>",
      "email": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "page": 123,
  "next": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.salesfinity.ai/llms.txt

Use this file to discover all available pages before exploring further.

Returns all snoozed contacts for the team with pagination and filtering support. Snoozed contacts are temporarily suppressed from call lists until their snooze period expires.

​
Query Parameters

  • page (optional, number): Page number for pagination. Default: 1
  • limit (optional, number): Number of items per page. Min: 1, Max: 100
  • sort (optional, string): Sort field(s). Prefix with ”-” for descending order. Default: -createdAt
  • linkedin_username (optional, string): Filter by LinkedIn username
  • external_contact_id (optional, string): Filter by external contact ID (e.g., CRM ID)
  • email (optional, string): Filter by email address
  • phone_number (optional, string): Filter by phone number

​
Response

Returns a paginated array of snoozed contacts with the following fields:
  • _id - Unique identifier
  • team - Team ID
  • user - User who snoozed the contact
  • contact_list - Associated contact list ID
  • linkedin_username - LinkedIn username
  • external_contact_id - External CRM contact ID
  • email - Email address
  • phone_number - Phone number
  • snooze_until - Date when snooze expires
  • createdAt - Creation timestamp
  • updatedAt - Last update timestamp

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
limit
integer

Items per page

Required range: 1 <= x <= 100
​
sort
string

Sort field(s). Prefix with - for descending

​
linkedin_username
string

Filter by LinkedIn username

​
external_contact_id
string

Filter by external contact ID

​
email
string

Filter by email

​
phone_number
string

Filter by phone number

Response

200 - application/json

Snoozed contacts retrieved successfully

​
data
object[]
​
total
integer
​
page
integer
​
next
integer | null