Skip to main content
GET
/
v3
/
settings
Get settings
curl --request GET \
  --url https://api.reply.io/v3/settings \
  --header 'X-API-Key: <api-key>'
{
  "account": {
    "firstName": "<string>",
    "lastName": "<string>",
    "company": "<string>",
    "phone": "<string>",
    "title": "<string>",
    "timezone": "<string>"
  },
  "emails": {
    "isEmailQualityCheckEnabled": true,
    "safety": {
      "firstStepDelay": 1,
      "prospectEmailsPerDayLimit": 2,
      "nonRepliesHandlingType": 1,
      "inboxNonRepliesHandlingType": 0
    },
    "inbox": {
      "bccList": "<string>",
      "repliesBccList": "<string>",
      "forwardOnlyReplies": true
    },
    "outOfOffice": {
      "isResumeOutOfOfficeContactsEnabled": true,
      "isUseSmartReturnDateEnabled": true,
      "defaultDaysToWaitBeforeResumingOutOfOffice": 2,
      "maximumDaysThresholdBeforeResumingOutOfOffice": 2
    },
    "isOpenTrackingDisabled": true,
    "isAutomaticEmailValidationEnabled": true,
    "reassignSequenceProspectsWhenEmailAccountAdded": true
  },
  "linkedIn": {
    "reassignSequenceProspectsWhenLinkedInAccountAdded": true
  },
  "calls": {
    "isTeamCallsEnabled": true,
    "resolutions": [
      {
        "name": "<string>",
        "id": 123,
        "defaultResolutionValue": 1,
        "isDefault": true
      }
    ]
  },
  "contacts": {
    "handling": {
      "pauseProspectOrganizationMode": true,
      "pauseProspectOrganizationValue": 1,
      "pauseProspectInAllCampaignMode": true,
      "pauseProspectInAllCampaignValue": 1,
      "leaveProspectsInSequenceWhenMovingToAnother": true,
      "enrichProspectWhenLinkedInUrlIsMissing": true
    },
    "contactAccounts": {
      "autoPopulate": true,
      "overwriteFields": true
    },
    "contactStages": [
      {
        "id": 4,
        "name": "<string>",
        "colorId": 123,
        "description": "<string>"
      }
    ],
    "accountStages": [
      {
        "id": 4,
        "name": "<string>",
        "colorId": 123
      }
    ]
  },
  "beta": {
    "isBetaFeaturesEnabled": true
  }
}

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header

Response

Settings retrieved successfully

Team and user settings. All properties are nullable — on GET, null means the setting is not configured or not applicable. On PATCH, only properties present in the JSON body are updated.

account
object

User profile settings

emails
object

Email-related settings

linkedIn
object

LinkedIn-related settings

calls
object

Call-related settings

contacts
object

Contact-related settings

beta
object

Beta features settings