Contacts

Operations related to contacts

Get all Contacts

get

Returns a list of contacts with pagination support.

Authorizations

x-api-key

x-api-keystringRequired

Query parameters

pagenumberOptional

Page number to retrieve.

limitnumberOptional

Number of items per page.

emailstringOptional

Contact email to filter contacts by (partial match).

namestringOptional

Contact name to filter contacts by (partial match).

opportunityIdstringOptional

Opportunity ID to filter contacts by.

companyIdstringOptional

Company ID to filter contacts by.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/contacts

HTTPcURLJavaScriptPython

GET /api/v1/contacts HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": [
    {
      "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
      "firstName": "John",
      "lastName": "Doe",
      "salutation": "Mr.",
      "birthday": "1990-01-15T00:00:00.000Z",
      "email": "[email protected]",
      "phone": "[phone]",
      "genderIdentity": "Male",
      "pronouns": "he/him",
      "fax": "[phone]",
      "linkedinUrl": "https://linkedin.com/in/johndoe",
      "address": "123 Main Street",
      "postalCode": "12345",
      "city": "New York",
      "state": "NY",
      "country": "United States",
      "currency": "USD",
      "titlePosition": "Software Engineer",
      "language": "English",
      "assistant": "Jane Smith",
      "assistantPhone": "[phone]",
      "division": "Engineering",
      "department": "Software Development",
      "description": "Senior software engineer with 5 years of experience",
      "leadSource": "Website",
      "leadRecordType": "Lead",
      "reportsTo": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
      "createdAt": "2024-01-15T10:00:00.000Z",
      "updatedAt": "2024-01-15T10:00:00.000Z",
      "personId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
    }
  ]
}

Create Contact

post

Creates a new contact.

Authorizations

x-api-key

x-api-keystringRequired

Body

application/json

firstNamestringOptional

First name of the contact

Example: John

lastNamestringOptional

Last name of the contact

Example: Doe

salutationstringOptional

Salutation of the contact

Example: Mr.

birthdaystring · date-timeOptional

Birthday of the contact

Example: 1990-01-15T00:00:00.000Z

emailstringRequired

Email address of the contact

Example: [email protected]

phonestringOptional

Phone number of the contact

Example: [phone]

genderIdentitystringOptional

Gender identity of the contact

Example: Male

pronounsstringOptional

Pronouns of the contact

Example: he/him

faxstringOptional

Fax number of the contact

Example: [phone]

linkedinUrlstringOptional

LinkedIn URL of the contact

Example: https://linkedin.com/in/johndoe

addressstringOptional

Address of the contact

Example: 123 Main Street

postalCodestringOptional

Postal code of the contact

Example: 12345

citystringOptional

City of the contact

Example: New York

statestringOptional

State of the contact

Example: NY

countrystringOptional

Country of the contact

Example: United States

currencystringOptional

Currency preference of the contact

Example: USD

titlePositionstringOptional

Title/Position of the contact

Example: Software Engineer

languagestringOptional

Language preference of the contact

Example: English

assistantstringOptional

Assistant name of the contact

Example: Jane Smith

assistantPhonestringOptional

Assistant phone number

Example: [phone]

divisionstringOptional

Division of the contact

Example: Engineering

departmentstringOptional

Department of the contact

Example: Software Development

descriptionstringOptional

Description of the contact

Example: Senior software engineer with 5 years of experience

leadSourcestringOptional

Lead source of the contact

Example: Website

leadRecordTypestringOptional

Lead record type

Example: Lead

reportsTostringOptional

Reports to contact ID

Example: 5516cd47-2bd0-4f4f-adc2-22524e54ba4d

Responses

201Success

application/json

401

Unauthorized - missing or invalid API key

post

/api/v1/contacts

HTTPcURLJavaScriptPython

POST /api/v1/contacts HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 734

{
  "firstName": "John",
  "lastName": "Doe",
  "salutation": "Mr.",
  "birthday": "1990-01-15T00:00:00.000Z",
  "email": "[email protected]",
  "phone": "[phone]",
  "genderIdentity": "Male",
  "pronouns": "he/him",
  "fax": "[phone]",
  "linkedinUrl": "https://linkedin.com/in/johndoe",
  "address": "123 Main Street",
  "postalCode": "12345",
  "city": "New York",
  "state": "NY",
  "country": "United States",
  "currency": "USD",
  "titlePosition": "Software Engineer",
  "language": "English",
  "assistant": "Jane Smith",
  "assistantPhone": "[phone]",
  "division": "Engineering",
  "department": "Software Development",
  "description": "Senior software engineer with 5 years of experience",
  "leadSource": "Website",
  "leadRecordType": "Lead",
  "reportsTo": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
}

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "firstName": "John",
    "lastName": "Doe",
    "salutation": "Mr.",
    "birthday": "1990-01-15T00:00:00.000Z",
    "email": "[email protected]",
    "phone": "[phone]",
    "genderIdentity": "Male",
    "pronouns": "he/him",
    "fax": "[phone]",
    "linkedinUrl": "https://linkedin.com/in/johndoe",
    "address": "123 Main Street",
    "postalCode": "12345",
    "city": "New York",
    "state": "NY",
    "country": "United States",
    "currency": "USD",
    "titlePosition": "Software Engineer",
    "language": "English",
    "assistant": "Jane Smith",
    "assistantPhone": "[phone]",
    "division": "Engineering",
    "department": "Software Development",
    "description": "Senior software engineer with 5 years of experience",
    "leadSource": "Website",
    "leadRecordType": "Lead",
    "reportsTo": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "createdAt": "2024-01-15T10:00:00.000Z",
    "updatedAt": "2024-01-15T10:00:00.000Z",
    "personId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
  }
}

Get Contact by ID

get

Get a contact by ID.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Contact ID to retrieve.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/contacts/{id}

HTTPcURLJavaScriptPython

GET /api/v1/contacts/{id} HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "firstName": "John",
    "lastName": "Doe",
    "salutation": "Mr.",
    "birthday": "1990-01-15T00:00:00.000Z",
    "email": "[email protected]",
    "phone": "[phone]",
    "genderIdentity": "Male",
    "pronouns": "he/him",
    "fax": "[phone]",
    "linkedinUrl": "https://linkedin.com/in/johndoe",
    "address": "123 Main Street",
    "postalCode": "12345",
    "city": "New York",
    "state": "NY",
    "country": "United States",
    "currency": "USD",
    "titlePosition": "Software Engineer",
    "language": "English",
    "assistant": "Jane Smith",
    "assistantPhone": "[phone]",
    "division": "Engineering",
    "department": "Software Development",
    "description": "Senior software engineer with 5 years of experience",
    "leadSource": "Website",
    "leadRecordType": "Lead",
    "reportsTo": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "createdAt": "2024-01-15T10:00:00.000Z",
    "updatedAt": "2024-01-15T10:00:00.000Z",
    "personId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
  }
}

Update Contact

put

Updates an existing contact.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Contact ID to update.

Body

application/json

firstNamestringOptional

First name of the contact

Example: John

lastNamestringOptional

Last name of the contact

Example: Doe

salutationstringOptional

Salutation of the contact

Example: Mr.

birthdaystring · date-timeOptional

Birthday of the contact

Example: 1990-01-15T00:00:00.000Z

emailstringOptional

Email address of the contact

Example: [email protected]

phonestringOptional

Phone number of the contact

Example: [phone]

genderIdentitystringOptional

Gender identity of the contact

Example: Male

pronounsstringOptional

Pronouns of the contact

Example: he/him

faxstringOptional

Fax number of the contact

Example: [phone]

linkedinUrlstringOptional

LinkedIn URL of the contact

Example: https://linkedin.com/in/johndoe

addressstringOptional

Address of the contact

Example: 123 Main Street

postalCodestringOptional

Postal code of the contact

Example: 12345

citystringOptional

City of the contact

Example: New York

statestringOptional

State of the contact

Example: NY

countrystringOptional

Country of the contact

Example: United States

currencystringOptional

Currency preference of the contact

Example: USD

titlePositionstringOptional

Title/Position of the contact

Example: Software Engineer

languagestringOptional

Language preference of the contact

Example: English

assistantstringOptional

Assistant name of the contact

Example: Jane Smith

assistantPhonestringOptional

Assistant phone number

Example: [phone]

divisionstringOptional

Division of the contact

Example: Engineering

departmentstringOptional

Department of the contact

Example: Software Development

descriptionstringOptional

Description of the contact

Example: Senior software engineer with 5 years of experience

leadSourcestringOptional

Lead source of the contact

Example: Website

leadRecordTypestringOptional

Lead record type

Example: Lead

reportsTostringOptional

Reports to contact ID

Example: 5516cd47-2bd0-4f4f-adc2-22524e54ba4d

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

put

/api/v1/contacts/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/contacts/{id} HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 734

{
  "firstName": "John",
  "lastName": "Doe",
  "salutation": "Mr.",
  "birthday": "1990-01-15T00:00:00.000Z",
  "email": "[email protected]",
  "phone": "[phone]",
  "genderIdentity": "Male",
  "pronouns": "he/him",
  "fax": "[phone]",
  "linkedinUrl": "https://linkedin.com/in/johndoe",
  "address": "123 Main Street",
  "postalCode": "12345",
  "city": "New York",
  "state": "NY",
  "country": "United States",
  "currency": "USD",
  "titlePosition": "Software Engineer",
  "language": "English",
  "assistant": "Jane Smith",
  "assistantPhone": "[phone]",
  "division": "Engineering",
  "department": "Software Development",
  "description": "Senior software engineer with 5 years of experience",
  "leadSource": "Website",
  "leadRecordType": "Lead",
  "reportsTo": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
}

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "firstName": "John",
    "lastName": "Doe",
    "salutation": "Mr.",
    "birthday": "1990-01-15T00:00:00.000Z",
    "email": "[email protected]",
    "phone": "[phone]",
    "genderIdentity": "Male",
    "pronouns": "he/him",
    "fax": "[phone]",
    "linkedinUrl": "https://linkedin.com/in/johndoe",
    "address": "123 Main Street",
    "postalCode": "12345",
    "city": "New York",
    "state": "NY",
    "country": "United States",
    "currency": "USD",
    "titlePosition": "Software Engineer",
    "language": "English",
    "assistant": "Jane Smith",
    "assistantPhone": "[phone]",
    "division": "Engineering",
    "department": "Software Development",
    "description": "Senior software engineer with 5 years of experience",
    "leadSource": "Website",
    "leadRecordType": "Lead",
    "reportsTo": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "createdAt": "2024-01-15T10:00:00.000Z",
    "updatedAt": "2024-01-15T10:00:00.000Z",
    "personId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
  }
}

Delete Contact

delete

Deletes a contact by ID.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Contact ID to delete.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

delete

/api/v1/contacts/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/contacts/{id} HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": true
}

Get Contact Integrations

get

Returns a list of integrations for a given contact ID.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Contact ID to get integrations from.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/contacts/{id}/integrations

HTTPcURLJavaScriptPython

GET /api/v1/contacts/{id}/integrations HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "contactId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "integrations": [
      {
        "integrationType": "crm",
        "integrationName": "HubSpot",
        "integrationId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
      }
    ]
  }
}

Get Contact Companies

get

Returns a list of companies associated with a contact.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Contact ID to get companies from.

Query parameters

pagenumberOptional

Page number to retrieve.

limitnumberOptional

Number of items per page.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/contacts/{id}/companies

HTTPcURLJavaScriptPython

GET /api/v1/contacts/{id}/companies HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": [
    {
      "companyId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
      "companyName": "Acme Corp",
      "companyDomain": "acme.com"
    }
  ]
}

Create Contact Company Relationship

post

Creates a relationship between a contact and a company.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Contact ID.

Body

application/json

companyIdstringRequired

Company ID

Example: 5516cd47-2bd0-4f4f-adc2-22524e54ba4d

Responses

201Success

application/json

401

Unauthorized - missing or invalid API key

post

/api/v1/contacts/{id}/companies

HTTPcURLJavaScriptPython

POST /api/v1/contacts/{id}/companies HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "companyId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
}

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": true
}

Get Contact Opportunities

get

Returns a list of opportunities associated with a contact.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Contact ID to get opportunities from.

Query parameters

pagenumberOptional

Page number to retrieve.

limitnumberOptional

Number of items per page.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/contacts/{id}/opportunities

HTTPcURLJavaScriptPython

GET /api/v1/contacts/{id}/opportunities HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": [
    {
      "opportunityId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
      "opportunityName": "Q1 Sales Deal",
      "opportunityAmount": 50000,
      "opportunityStatus": "Open"
    }
  ]
}

Create Contact Opportunity Relationship

post

Creates a relationship between a contact and an opportunity.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Body

application/json

opportunityIdstringRequired

Opportunity ID

Example: 5516cd47-2bd0-4f4f-adc2-22524e54ba4d

Responses

201Success

application/json

401

Unauthorized - missing or invalid API key

post

/api/v1/contacts/{id}/opportunities

HTTPcURLJavaScriptPython

POST /api/v1/contacts/{id}/opportunities HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "opportunityId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
}

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": true
}

Delete Contact Company Relationship

delete

Deletes a relationship between a contact and a company.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Contact ID.

companyIdstringRequired

Company ID.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

delete

/api/v1/contacts/{id}/companies/{companyId}

HTTPcURLJavaScriptPython

DELETE /api/v1/contacts/{id}/companies/{companyId} HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": true
}

Delete Contact Opportunity Relationship

delete

Deletes a relationship between a contact and an opportunity.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

opportunityIdstringRequired

Opportunity ID.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

delete

/api/v1/contacts/{id}/opportunities/{opportunityId}

HTTPcURLJavaScriptPython

DELETE /api/v1/contacts/{id}/opportunities/{opportunityId} HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": true
}