Companies

Operations related to companies

Get all Companies

get

Returns a list of companies with pagination support.

Authorizations

x-api-key

x-api-keystringRequired

Query parameters

pagenumberOptional

Page number to retrieve.

limitnumberOptional

Number of items per page.

namestringOptional

Company name to filter companies by (partial match).

domainstringOptional

Company domain to filter companies by (partial match).

opportunityIdstringOptional

Opportunity ID to filter companies by opportunity relationship.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/companies

HTTPcURLJavaScriptPython

GET /api/v1/companies 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",
      "name": "Acme Corporation",
      "domain": "acme.com",
      "description": "Leading provider of innovative solutions",
      "industry": "Technology",
      "phone": "[phone]",
      "email": "[email protected]",
      "currency": "USD",
      "address": "123 Main Street",
      "postalCode": "12345",
      "city": "New York",
      "nEmployees": 150,
      "source": "Website",
      "annualRevenue": 1000000,
      "status": "Active",
      "foundationYear": 2020,
      "sellRating": 85,
      "linkedinUrl": "https://linkedin.com/company/acme-corp",
      "parentCompanyId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
      "createdAt": "2024-01-15T10:00:00.000Z",
      "updatedAt": "2024-01-15T10:00:00.000Z"
    }
  ]
}

Create Company

post

Creates a new company.

Authorizations

x-api-key

x-api-keystringRequired

Body

application/json

namestringRequired

Name of the company

Example: Acme Corporation

domainstringRequired

Company domain

Example: acme.com

descriptionstringOptional

Company description

Example: Leading provider of innovative solutions

industrystringOptional

Company industry

Example: Technology

phonestringOptional

Company phone number

Example: [phone]

emailstringOptional

Company email address

Example: [email protected]

currencystringOptional

Company currency

Example: USD

addressstringOptional

Company address

Example: 123 Main Street

postalCodestringOptional

Postal code

Example: 12345

citystringOptional

City

Example: New York

nEmployeesnumberOptional

Number of employees

Example: 150

sourcestringOptional

Company source

Example: Website

annualRevenuenumberOptional

Annual revenue

Example: 1000000

statusstringOptional

Company status

Example: Active

foundationYearnumberOptional

Foundation year

Example: 2020

sellRatingnumberOptional

Sell rating (0-100)

Example: 85

linkedinUrlstringOptional

LinkedIn URL

Example: https://linkedin.com/company/acme-corp

parentCompanyIdstringOptional

Parent company ID

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

Responses

201Success

application/json

401

Unauthorized - missing or invalid API key

post

/api/v1/companies

HTTPcURLJavaScriptPython

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

{
  "name": "Acme Corporation",
  "domain": "acme.com",
  "description": "Leading provider of innovative solutions",
  "industry": "Technology",
  "phone": "[phone]",
  "email": "[email protected]",
  "currency": "USD",
  "address": "123 Main Street",
  "postalCode": "12345",
  "city": "New York",
  "nEmployees": 150,
  "source": "Website",
  "annualRevenue": 1000000,
  "status": "Active",
  "foundationYear": 2020,
  "sellRating": 85,
  "linkedinUrl": "https://linkedin.com/company/acme-corp",
  "parentCompanyId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
}

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "name": "Acme Corporation",
    "domain": "acme.com",
    "description": "Leading provider of innovative solutions",
    "industry": "Technology",
    "phone": "[phone]",
    "email": "[email protected]",
    "currency": "USD",
    "address": "123 Main Street",
    "postalCode": "12345",
    "city": "New York",
    "nEmployees": 150,
    "source": "Website",
    "annualRevenue": 1000000,
    "status": "Active",
    "foundationYear": 2020,
    "sellRating": 85,
    "linkedinUrl": "https://linkedin.com/company/acme-corp",
    "parentCompanyId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "createdAt": "2024-01-15T10:00:00.000Z",
    "updatedAt": "2024-01-15T10:00:00.000Z"
  }
}

Get Company by ID

get

Get a company by ID.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Company ID to retrieve.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/companies/{id}

HTTPcURLJavaScriptPython

GET /api/v1/companies/{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",
    "name": "Acme Corporation",
    "domain": "acme.com",
    "description": "Leading provider of innovative solutions",
    "industry": "Technology",
    "phone": "[phone]",
    "email": "[email protected]",
    "currency": "USD",
    "address": "123 Main Street",
    "postalCode": "12345",
    "city": "New York",
    "nEmployees": 150,
    "source": "Website",
    "annualRevenue": 1000000,
    "status": "Active",
    "foundationYear": 2020,
    "sellRating": 85,
    "linkedinUrl": "https://linkedin.com/company/acme-corp",
    "parentCompanyId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "createdAt": "2024-01-15T10:00:00.000Z",
    "updatedAt": "2024-01-15T10:00:00.000Z"
  }
}

Update Company

put

Updates an existing company.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Company ID to update.

Body

application/json

namestringOptional

Name of the company

Example: Acme Corporation

domainstringOptional

Company domain

Example: acme.com

descriptionstringOptional

Company description

Example: Leading provider of innovative solutions

industrystringOptional

Company industry

Example: Technology

phonestringOptional

Company phone number

Example: [phone]

emailstringOptional

Company email address

Example: [email protected]

currencystringOptional

Company currency

Example: USD

addressstringOptional

Company address

Example: 123 Main Street

postalCodestringOptional

Postal code

Example: 12345

citystringOptional

City

Example: New York

nEmployeesnumberOptional

Number of employees

Example: 150

sourcestringOptional

Company source

Example: Website

annualRevenuenumberOptional

Annual revenue

Example: 1000000

statusstringOptional

Company status

Example: Active

foundationYearnumberOptional

Foundation year

Example: 2020

sellRatingnumberOptional

Sell rating (0-100)

Example: 85

linkedinUrlstringOptional

LinkedIn URL

Example: https://linkedin.com/company/acme-corp

parentCompanyIdstringOptional

Parent company ID

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

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

put

/api/v1/companies/{id}

HTTPcURLJavaScriptPython

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

{
  "name": "Acme Corporation",
  "domain": "acme.com",
  "description": "Leading provider of innovative solutions",
  "industry": "Technology",
  "phone": "[phone]",
  "email": "[email protected]",
  "currency": "USD",
  "address": "123 Main Street",
  "postalCode": "12345",
  "city": "New York",
  "nEmployees": 150,
  "source": "Website",
  "annualRevenue": 1000000,
  "status": "Active",
  "foundationYear": 2020,
  "sellRating": 85,
  "linkedinUrl": "https://linkedin.com/company/acme-corp",
  "parentCompanyId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
}

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "name": "Acme Corporation",
    "domain": "acme.com",
    "description": "Leading provider of innovative solutions",
    "industry": "Technology",
    "phone": "[phone]",
    "email": "[email protected]",
    "currency": "USD",
    "address": "123 Main Street",
    "postalCode": "12345",
    "city": "New York",
    "nEmployees": 150,
    "source": "Website",
    "annualRevenue": 1000000,
    "status": "Active",
    "foundationYear": 2020,
    "sellRating": 85,
    "linkedinUrl": "https://linkedin.com/company/acme-corp",
    "parentCompanyId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "createdAt": "2024-01-15T10:00:00.000Z",
    "updatedAt": "2024-01-15T10:00:00.000Z"
  }
}

Delete Company

delete

Deletes a company by ID.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Company ID to delete.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

delete

/api/v1/companies/{id}

HTTPcURLJavaScriptPython

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

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

Get Company Integrations

get

Returns a list of integrations for a given company ID.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Company ID to get integrations from.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/companies/{id}/integrations

HTTPcURLJavaScriptPython

GET /api/v1/companies/{id}/integrations 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",
    "integrations": [
      {
        "integrationType": "crm",
        "integrationName": "HubSpot",
        "integrationId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
      }
    ]
  }
}

Get Company Contacts

get

Returns a list of contacts associated with a company.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Company ID to get contacts 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/companies/{id}/contacts

HTTPcURLJavaScriptPython

GET /api/v1/companies/{id}/contacts 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",
      "contactFirstName": "John",
      "contactLastName": "Doe",
      "contactEmail": "[email protected]",
      "contactTitlePosition": "Software Engineer"
    }
  ]
}

Create Company Contact Relationship

post

Creates a relationship between a company and a contact.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Company ID.

Body

application/json

contactIdstringRequired

Contact ID

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

Responses

201Success

application/json

401

Unauthorized - missing or invalid API key

post

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

HTTPcURLJavaScriptPython

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

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

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

Get Company Opportunities

get

Returns a list of opportunities associated with a company.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Company 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/companies/{id}/opportunities

HTTPcURLJavaScriptPython

GET /api/v1/companies/{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 Company Opportunity Relationship

post

Creates a relationship between a company and an opportunity.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Company ID.

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/companies/{id}/opportunities

HTTPcURLJavaScriptPython

POST /api/v1/companies/{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 Company Contact Relationship

delete

Deletes a relationship between a company and a contact.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Company ID.

contactIdstringRequired

Contact ID.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

delete

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

HTTPcURLJavaScriptPython

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

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

Delete Company Opportunity Relationship

delete

Deletes a relationship between a company 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/companies/{id}/opportunities/{opportunityId}

HTTPcURLJavaScriptPython

DELETE /api/v1/companies/{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
}