Marketsharp CRM API

https://restapi.marketsharpm.com
Admin
Marketsharp CRM API is a comprehensive REST API that provides access to CRM functionality including...
Tokens:32,348
Snippets:92
Trust Score:7.2
Update:6 months ago
Show doc for...
Tokens:
Raw
### Texting Setup API

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Endpoints for managing text message setup and configuration.

```APIDOC
## GET /companies/{companyid}/texting/setup

### Description
Retrieves the full text message setup data for a company.

### Method
GET

### Endpoint
/companies/{companyid}/texting/setup

### Parameters
#### Path Parameters
- **companyid** (string) - Required - The ID of the company.

## PUT /companies/{companyid}/texting/setup

### Description
Saves text message setup settings for a company.

### Method
PUT

### Endpoint
/companies/{companyid}/texting/setup

### Parameters
#### Path Parameters
- **companyid** (string) - Required - The ID of the company.

## POST /companies/{companyid}/texting/setup/account

### Description
Initializes the texting account with a friendly name during the new setup process.

### Method
POST

### Endpoint
/companies/{companyid}/texting/setup/account

### Parameters
#### Path Parameters
- **companyid** (string) - Required - The ID of the company.
```

--------------------------------

### Activity Processes - Get Specific

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Retrieve details for a specific activity process.

```APIDOC
## GET /companies/{companyid}/activities/processes/{activityProcessId}

### Description
Get details of a specific activity process.

### Method
GET

### Endpoint
/companies/{companyid}/activities/processes/{activityProcessId}

### Parameters
#### Path Parameters
- **companyid** (string) - Required - The ID of the company.
- **activityProcessId** (string) - Required - The ID of the activity process.

### Response
#### Success Response (200)
(Response details not provided in source text)

#### Response Example
(Response example not provided in source text)
```

--------------------------------

### Activity References - Get

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Retrieve activity references for a company.

```APIDOC
## GET /companies/{companyId}/activities/references

### Description
Get activity references for a company.

### Method
GET

### Endpoint
/companies/{companyId}/activities/references

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.

### Response
#### Success Response (200)
- **references** (array) - A list of activity references.

#### Response Example
(Response example not provided in source text)
```

--------------------------------

### Address - Get Countries

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Retrieve a list of all supported countries.

```APIDOC
## GET /companies/{companyid}/address/countries

### Description
Get a list of all the supported countries.

### Method
GET

### Endpoint
/companies/{companyid}/address/countries

### Parameters
#### Path Parameters
- **companyid** (string) - Required - The ID of the company.

### Response
#### Success Response (200)
- **countries** (array) - A list of supported countries.

#### Response Example
(Response example not provided in source text)
```

--------------------------------

### Address - Get States

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Retrieve a list of supported states for a given country.

```APIDOC
## GET /companies/{companyid}/address/states/{countryOid}

### Description
Get a list of all the currently supported states in a desired country. If countryOid is empty, assume the USA.

### Method
GET

### Endpoint
/companies/{companyid}/address/states/{countryOid}

### Parameters
#### Path Parameters
- **companyid** (string) - Required - The ID of the company.
- **countryOid** (string) - Optional - The Object ID of the country. Defaults to USA if empty.

### Response
#### Success Response (200)
- **states** (array) - A list of supported states.

#### Response Example
(Response example not provided in source text)
```

--------------------------------

### Activity Types - Get

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Retrieve a list of activity types for a company.

```APIDOC
## GET /companies/{companyid}/activities/types

### Description
Get activity types for a company.

### Method
GET

### Endpoint
/companies/{companyid}/activities/types

### Parameters
#### Path Parameters
- **companyid** (string) - Required - The ID of the company.

### Response
#### Success Response (200)
- **types** (array) - A list of activity types.

#### Response Example
(Response example not provided in source text)
```

--------------------------------

### Email API Endpoints

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0+Marketsharp+CRM+API

Endpoints for managing email setup, templates, and testing.

```APIDOC
## GET /companies/{companyid}/email/setup

### Description
Get SMTP Setup configuration.

### Method
GET

### Endpoint
/companies/{companyid}/email/setup
```

```APIDOC
## PUT /companies/{companyid}/email/setup

### Description
Save SMTP Setup configuration.

### Method
PUT

### Endpoint
/companies/{companyid}/email/setup
```

```APIDOC
## GET /companies/{companyid}/email/templates

### Description
Get active email templates.

### Method
GET

### Endpoint
/companies/{companyid}/email/templates
```

```APIDOC
## GET /companies/{companyid}/email/template/{templateId}/linkedevents

### Description
Get Email Template Dependencies.

### Method
GET

### Endpoint
/companies/{companyid}/email/template/{templateId}/linkedevents
```

```APIDOC
## POST /companies/{companyid}/email/setup/test

### Description
Send test email via SendGrid.

### Method
POST

### Endpoint
/companies/{companyid}/email/setup/test
```

--------------------------------

### Authentication - Get Token

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Use the /token endpoint to obtain an access token for API authentication. This token is then used in the Authorization header.

```APIDOC
## POST /token

### Description
Retrieve an access token for API authentication.

### Method
POST

### Endpoint
/token

### Request Body
(Authentication method details not provided in source text)

### Response
#### Success Response (200)
- **token** (string) - The access token.

#### Response Example
```json
{
  "token": "your_access_token"
}
```
```

--------------------------------

### Activity Processes - Get Activity Process ID

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Retrieve an activity process ID.

```APIDOC
## POST /companies/{companyid}/activitityprocessid

### Description
Get an activity process ID.

### Method
POST

### Endpoint
/companies/{companyid}/activitityprocessid

### Parameters
#### Path Parameters
- **companyid** (string) - Required - The ID of the company.

#### Request Body
(Details for getting the activity process ID not provided in source text)

### Response
#### Success Response (200)
(Response details not provided in source text)

#### Response Example
(Response example not provided in source text)
```

--------------------------------

### Activity Processes - List All

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Retrieve a list of all activity processes for a given company.

```APIDOC
## GET /companies/{companyId}/activities/processes

### Description
List all activity processes for a company.

### Method
GET

### Endpoint
/companies/{companyId}/activities/processes

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.

### Response
#### Success Response (200)
- **processes** (array) - A list of activity processes.

#### Response Example
(Response example not provided in source text)
```

--------------------------------

### Activity Processes - Add New

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Add a new activity process for a company.

```APIDOC
## POST /companies/{companyid}/activities/processes

### Description
Add a new activity process.

### Method
POST

### Endpoint
/companies/{companyid}/activities/processes

### Parameters
#### Path Parameters
- **companyid** (string) - Required - The ID of the company.

#### Request Body
(Details for the new activity process not provided in source text)

### Response
#### Success Response (200)
(Response details not provided in source text)

#### Response Example
(Response example not provided in source text)
```

--------------------------------

### Activity Processes - Proposed Activities

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Retrieve pending activities auto-generated from activity process configuration.

```APIDOC
## POST /companies/{companyId}/activities/process/{activityProcessId}/proposedActivities

### Description
Returns pending activities auto-generated from activity process configuration.

### Method
POST

### Endpoint
/companies/{companyId}/activities/process/{activityProcessId}/proposedActivities

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.
- **activityProcessId** (string) - Required - The ID of the activity process.

### Response
#### Success Response (200)
(Response details not provided in source text)

#### Response Example
(Response example not provided in source text)
```

--------------------------------

### Products API Endpoints

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Endpoints for managing product information, user preferences, and production steps.

```APIDOC
## GET /companies/{companyId}/products/stepInfo/{stepId}

### Description
Retrieve Information about a Production Step

### Method
GET

### Endpoint
/companies/{companyId}/products/stepInfo/{stepId}
```

```APIDOC
## GET /companies/{companyId}/products/types/{activeOnly}

### Description
Retrieve Product Type

### Method
GET

### Endpoint
/companies/{companyId}/products/types/{activeOnly}
```

```APIDOC
## GET /companies/{companyId}/products/workcrew/{activeOnly}

### Description
Get Work Crew List

### Method
GET

### Endpoint
/companies/{companyId}/products/workcrew/{activeOnly}
```

```APIDOC
## GET /companies/{companyId}/products/interests/{activeOnly}

### Description
Get all product interests.

### Method
GET

### Endpoint
/companies/{companyId}/products/interests/{activeOnly}
```

```APIDOC
## GET /companies/{companyId}/products/interests/leads/{leadId}

### Description
Get product interests by lead id.

### Method
GET

### Endpoint
/companies/{companyId}/products/interests/leads/{leadId}
```

```APIDOC
## POST /companies/{companyId}/products/interests/leads/{leadId}

### Description
Associate product interest to lead.

### Method
POST

### Endpoint
/companies/{companyId}/products/interests/leads/{leadId}
```

```APIDOC
## GET /companies/{companyId}/products/jobProduct/{jobProductOid}

### Description
Get Job Product Information

### Method
GET

### Endpoint
/companies/{companyId}/products/jobProduct/{jobProductOid}
```

```APIDOC
## GET /companies/{companyId}/products/userPrefs/productionProcessList

### Description
Get Production User Pref List

### Method
GET

### Endpoint
/companies/{companyId}/products/userPrefs/productionProcessList
```

```APIDOC
## PUT /companies/{companyId}/products/userPrefs/productionProcessList

### Description
Update User Pref

### Method
PUT

### Endpoint
/companies/{companyId}/products/userPrefs/productionProcessList
```

```APIDOC
## GET /companies/{companyId}/products/processTypes/{activeOnly}

### Description
Get Process Type List

### Method
GET

### Endpoint
/companies/{companyId}/products/processTypes/{activeOnly}
```

```APIDOC
## GET /companies/{companyid}/products/jobProduct/{jobProductId}/process/{processId}/steps

### Description
Production Steps by Production Process Id

### Method
GET

### Endpoint
/companies/{companyid}/products/jobProduct/{jobProductId}/process/{processId}/steps
```

```APIDOC
## PUT /companies/{companyId}/products/workcrew

### Description
Update Work Crew List

### Method
PUT

### Endpoint
/companies/{companyId}/products/workcrew
```

```APIDOC
## PUT /companies/{companyId}/products/jobProduct

### Description
Update Job Product

### Method
PUT

### Endpoint
/companies/{companyId}/products/jobProduct
```

```APIDOC
## PUT /companies/{companyId}/products/stepInfoDates/{stepId}

### Description
Update Production Step Dates

### Method
PUT

### Endpoint
/companies/{companyId}/products/stepInfoDates/{stepId}
```

```APIDOC
## POST /companies/{companyId}/products/views/flat

### Description
Retrieve Flat/Pivot View of the production tab

### Method
POST

### Endpoint
/companies/{companyId}/products/views/flat
```

```APIDOC
## POST /companies/{companyid}/products/hasActivities

### Description
Check Link between Production Step and Activity

### Method
POST

### Endpoint
/companies/{companyid}/products/hasActivities
```

```APIDOC
## POST /companies/{companyId}/products/productionFlatTotalAmounts

### Description
Retrieve Total Amount in dollars shown on the production flat view

### Method
POST

### Endpoint
/companies/{companyId}/products/productionFlatTotalAmounts
```

```APIDOC
## POST /companies/{companyId}/products/interests/leads/{leadId}/unlink

### Description
Unlink product interest from lead.

### Method
POST

### Endpoint
/companies/{companyId}/products/interests/leads/{leadId}/unlink
```

--------------------------------

### Activity Processes - Update

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Update an existing activity process.

```APIDOC
## PUT /companies/{companyid}/activities/processes/{activityProcessId}

### Description
Updates an existing activity process.

### Method
PUT

### Endpoint
/companies/{companyid}/activities/processes/{activityProcessId}

### Parameters
#### Path Parameters
- **companyid** (string) - Required - The ID of the company.
- **activityProcessId** (string) - Required - The ID of the activity process to update.

#### Request Body
(Updated activity process details not provided in source text)

### Response
#### Success Response (200)
(Response details not provided in source text)

#### Response Example
(Response example not provided in source text)
```

--------------------------------

### Activity References - Add or Update

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Add or update activity references items for a company.

```APIDOC
## PUT /companies/{companyid}/activities/references

### Description
Add or update activity references items.

### Method
PUT

### Endpoint
/companies/{companyid}/activities/references

### Parameters
#### Path Parameters
- **companyid** (string) - Required - The ID of the company.

#### Request Body
(Activity references details not provided in source text)

### Response
#### Success Response (200)
(Response details not provided in source text)

#### Response Example
(Response example not provided in source text)
```

--------------------------------

### Products API Endpoints

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0+Marketsharp+CRM+API

Endpoints for managing product-related information, including steps, types, work crews, interests, and user preferences.

```APIDOC
## GET /companies/{companyId}/products/stepInfo/{stepId}

### Description
Retrieve Information about a Production Step.

### Method
GET

### Endpoint
/companies/{companyId}/products/stepInfo/{stepId}

## GET /companies/{companyId}/products/types/{activeOnly}

### Description
Retrieve Product Type.

### Method
GET

### Endpoint
/companies/{companyId}/products/types/{activeOnly}

## GET /companies/{companyId}/products/workcrew/{activeOnly}

### Description
Get Work Crew List.

### Method
GET

### Endpoint
/companies/{companyId}/products/workcrew/{activeOnly}

## GET /companies/{companyId}/products/interests/{activeOnly}

### Description
Get all product interests.

### Method
GET

### Endpoint
/companies/{companyId}/products/interests/{activeOnly}

## GET /companies/{companyId}/products/interests/leads/{leadId}

### Description
Get product interests by lead id.

### Method
GET

### Endpoint
/companies/{companyId}/products/interests/leads/{leadId}

## POST /companies/{companyId}/products/interests/leads/{leadId}

### Description
Associate product interest to lead.

### Method
POST

### Endpoint
/companies/{companyId}/products/interests/leads/{leadId}

## GET /companies/{companyId}/products/jobProduct/{jobProductOid}

### Description
Get Job Product Information.

### Method
GET

### Endpoint
/companies/{companyId}/products/jobProduct/{jobProductOid}

## GET /companies/{companyId}/products/userPrefs/productionProcessList

### Description
Get Production User Pref List.

### Method
GET

### Endpoint
/companies/{companyId}/products/userPrefs/productionProcessList

## PUT /companies/{companyId}/products/userPrefs/productionProcessList

### Description
Update User Pref.

### Method
PUT

### Endpoint
/companies/{companyId}/products/userPrefs/productionProcessList

## GET /companies/{companyId}/products/processTypes/{activeOnly}

### Description
Get Process Type List.

### Method
GET

### Endpoint
/companies/{companyId}/products/processTypes/{activeOnly}

## GET /companies/{companyid}/products/jobProduct/{jobProductId}/process/{processId}/steps

### Description
Production Steps by Production Process Id.

### Method
GET

### Endpoint
/companies/{companyid}/products/jobProduct/{jobProductId}/process/{processId}/steps

## PUT /companies/{companyId}/products/workcrew

### Description
Update Work Crew List.

### Method
PUT

### Endpoint
/companies/{companyId}/products/workcrew

## PUT /companies/{companyId}/products/jobProduct

### Description
Update Job Product.

### Method
PUT

### Endpoint
/companies/{companyId}/products/jobProduct

## PUT /companies/{companyId}/products/stepInfoDates/{stepId}

### Description
Update Production Step Dates.

### Method
PUT

### Endpoint
/companies/{companyId}/products/stepInfoDates/{stepId}

## POST /companies/{companyId}/products/views/flat

### Description
Retrieve Flat/Pivot View of the production tab.

### Method
POST

### Endpoint
/companies/{companyId}/products/views/flat

## POST /companies/{companyid}/products/hasActivities

### Description
Check Link between Production Step and Activity.

### Method
POST

### Endpoint
/companies/{companyid}/products/hasActivities

## POST /companies/{companyId}/products/productionFlatTotalAmounts

### Description
Retrieve Total Amount in dollars shown on the production flat view.

### Method
POST

### Endpoint
/companies/{companyId}/products/productionFlatTotalAmounts

## POST /companies/{companyId}/products/interests/leads/{leadId}/unlink

### Description
Unlink product interest from lead.

### Method
POST

### Endpoint
/companies/{companyId}/products/interests/leads/{leadId}/unlink
```

--------------------------------

### LeadCaptures API

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0+Marketsharp+CRM+API

Endpoints for managing lead capture data.

```APIDOC
## GET /companies/{companyId}/leadcaptures/custom

### Description
List all custom lead captures for a company.

### Method
GET

### Endpoint
/companies/{companyId}/leadcaptures/custom

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.
```

```APIDOC
## GET /companies/{companyId}/leadcaptures/iCapture

### Description
List iCapture lead captures for a company.

### Method
GET

### Endpoint
/companies/{companyId}/leadcaptures/iCapture

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.
```

```APIDOC
## POST /leadcaptures/{applicationInternalName}/contacts/filter

### Description
List global active contacts submitted by a lead capture app since the latest updated date/time.

### Method
POST

### Endpoint
/leadcaptures/{applicationInternalName}/contacts/filter

### Parameters
#### Path Parameters
- **applicationInternalName** (string) - Required - The internal name of the lead capture application.

### Request Body
(Schema not provided in source text)
```

```APIDOC
## POST /companies/{companyId}/leadcaptures/{applicationInternalName}/contacts/filter

### Description
List active contacts submitted by a lead capture app since the latest updated date/time for a specific company.

### Method
POST

### Endpoint
/companies/{companyId}/leadcaptures/{applicationInternalName}/contacts/filter

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.
- **applicationInternalName** (string) - Required - The internal name of the lead capture application.

### Request Body
(Schema not provided in source text)
```

--------------------------------

### Activity Result - Retrieve

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Retrieve activity results for a company.

```APIDOC
## GET /companies/{companyId}/activities/results

### Description
Retrieve Activity Results for a company.

### Method
GET

### Endpoint
/companies/{companyId}/activities/results

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.

### Response
#### Success Response (200)
- **results** (array) - A list of activity results.

#### Response Example
(Response example not provided in source text)
```

--------------------------------

### PermissionsV API Endpoints

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Endpoints for managing permissions and roles.

```APIDOC
## GET /companies/{companyId}/permissions/roles

### Description
Get all permission roles.

### Method
GET

### Endpoint
/companies/{companyId}/permissions/roles
```

--------------------------------

### PrimaryLeadSources API

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0+Marketsharp+CRM+API

Endpoints for managing primary and secondary lead sources.

```APIDOC
## GET /companies/{companyId}/primaryleadsources

### Description
List all primary lead sources for a company.

### Method
GET

### Endpoint
/companies/{companyId}/primaryleadsources

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.
```

```APIDOC
## GET /companies/{companyId}/primaryleadsources/active

### Description
List all active primary lead sources for a company.

### Method
GET

### Endpoint
/companies/{companyId}/primaryleadsources/active

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.
```

```APIDOC
## GET /companies/{companyId}/primaryleadsources/{primaryLeadSourceId}/secondaryleadsources

### Description
List all secondary lead sources for a given primary lead source within a company.

### Method
GET

### Endpoint
/companies/{companyId}/primaryleadsources/{primaryLeadSourceId}/secondaryleadsources

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.
- **primaryLeadSourceId** (string) - Required - The ID of the primary lead source.
```

```APIDOC
## GET /companies/{companyId}/primaryleadsources/{primaryLeadSourceId}/secondaryleadsources/active

### Description
List all active secondary lead sources for a given primary lead source within a company.

### Method
GET

### Endpoint
/companies/{companyId}/primaryleadsources/{primaryLeadSourceId}/secondaryleadsources/active

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.
- **primaryLeadSourceId** (string) - Required - The ID of the primary lead source.
```

--------------------------------

### Login API

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0+Marketsharp+CRM+API

Endpoints for managing user login and authentication cookies.

```APIDOC
## GET /companies/{companyId}/login/isvalidcookie

### Description
Validate the MarketSharp Login Cookie.

### Method
GET

### Endpoint
/companies/{companyId}/login/isvalidcookie

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.
```

```APIDOC
## POST /companies/{companyId}/login/authcookie

### Description
Get the MarketSharp Login Cookie.

### Method
POST

### Endpoint
/companies/{companyId}/login/authcookie

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.

### Request Body
(Schema not provided in source text)
```

--------------------------------

### CompanyCam API

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Endpoints for managing CompanyCam integration and data.

```APIDOC
## GET /companies/{companyId}/companyCam/credentials

### Description
Get CompanyCam credentials for the given company. Returns null if no credentials exist.

### Method
GET

### Endpoint
/companies/{companyId}/companyCam/credentials

## PUT /companies/{companyId}/companyCam/credentials

### Description
Update CompanyCam credentials for the given company.

### Method
PUT

### Endpoint
/companies/{companyId}/companyCam/credentials

## POST /companies/{companyId}/companyCam/credentials

### Description
Add CompanyCam credentials for the given company.

### Method
POST

### Endpoint
/companies/{companyId}/companyCam/credentials

## GET /companies/{companyId}/companyCam/projects/{entityType}/{entityId}

### Description
Get the list of CompanyCam projects based on entity type and entity id.

### Method
GET

### Endpoint
/companies/{companyId}/companyCam/projects/{entityType}/{entityId}

## POST /companies/{companyId}/companyCam/projects

### Description
Create CompanyCam project.

### Method
POST

### Endpoint
/companies/{companyId}/companyCam/projects

## DELETE /companies/{companyId}/companyCam/projects/{entityType}/{projectId}

### Description
Sends a DELETE request to the CompanyCam API to delete project based on projectId.

### Method
DELETE

### Endpoint
/companies/{companyId}/companyCam/projects/{entityType}/{projectId}
```

--------------------------------

### Activity - Save Activity

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Endpoint to save a new activity for a specific company.

```APIDOC
## POST /companies/{companyid}/activities

### Description
Save a new activity for a specific company.

### Method
POST

### Endpoint
/companies/{companyid}/activities

### Parameters
#### Path Parameters
- **companyid** (string) - Required - The ID of the company.

#### Request Body
(Activity details not provided in source text)

### Response
#### Success Response (200)
(Response details not provided in source text)

#### Response Example
(Response example not provided in source text)
```

--------------------------------

### Activity Processes - Soft Delete

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Soft delete an existing activity process.

```APIDOC
## DELETE /companies/{companyid}/activities/processes/{activityProcessId}

### Description
Soft deletes an existing activity process.

### Method
DELETE

### Endpoint
/companies/{companyid}/activities/processes/{activityProcessId}

### Parameters
#### Path Parameters
- **companyid** (string) - Required - The ID of the company.
- **activityProcessId** (string) - Required - The ID of the activity process to delete.

### Response
#### Success Response (200)
(Response details not provided in source text)

#### Response Example
(Response example not provided in source text)
```

--------------------------------

### ActivityProcesses API

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0+Marketsharp+CRM+API

Endpoints related to managing and retrieving activity processes within a company.

```APIDOC
## GET /companies/{companyId}/activityprocesses

### Description
Lists all activity processes for a specified company.

### Method
GET

### Endpoint
/companies/{companyId}/activityprocesses

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The unique identifier for the company.

### Response
#### Success Response (200)
- **activityProcesses** (array) - A list of activity process objects.
  - **id** (string) - The ID of the activity process.
  - **name** (string) - The name of the activity process.

#### Response Example
```json
{
  "activityProcesses": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Sales Follow-up"
    }
  ]
}
```
```

```APIDOC
## POST /companies/{companyid}/activitityprocessid

### Description
Retrieves an activity process ID. The exact parameters and response for this endpoint are not detailed in the provided text.

### Method
POST

### Endpoint
/companies/{companyid}/activitityprocessid

### Parameters
*Note: Specific parameters for this endpoint are not detailed in the provided text.*

### Response
*Note: Specific response details for this endpoint are not detailed in the provided text.*
```

```APIDOC
## POST /companies/{companyId}/activities/process/{activityProcessId}/proposedActivities

### Description
Returns pending activities that have been auto-generated based on activity process configuration.

### Method
POST

### Endpoint
/companies/{companyId}/activities/process/{activityProcessId}/proposedActivities

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The unique identifier for the company.
- **activityProcessId** (string) - Required - The unique identifier for the activity process.

### Response
#### Success Response (200)
- **proposedActivities** (array) - A list of proposed activity objects.
  - **id** (string) - The ID of the proposed activity.
  - **description** (string) - A description of the proposed activity.

#### Response Example
```json
{
  "proposedActivities": [
    {
      "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "description": "Follow up with lead John Doe regarding proposal."
    }
  ]
}
```
```

--------------------------------

### Logger API

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0+Marketsharp+CRM+API

Endpoints for logging client-side exceptions.

```APIDOC
## POST /logger/log/clientsideexception

### Description
Log Client Side Exceptions.

### Method
POST

### Endpoint
/logger/log/clientsideexception

### Request Body
(Schema not provided in source text)
```

```APIDOC
## POST /logger/log/loginclientsideexception

### Description
Log Client Side Exceptions related to login.

### Method
POST

### Endpoint
/logger/log/loginclientsideexception

### Request Body
(Schema not provided in source text)
```

--------------------------------

### Login API

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Endpoints for validating and obtaining login cookies.

```APIDOC
## GET /companies/{companyId}/login/isvalidcookie

### Description
Validate MS Login Cookie

### Method
GET

### Endpoint
/companies/{companyId}/login/isvalidcookie
```

```APIDOC
## POST /companies/{companyId}/login/authcookie

### Description
Get MS Login Cookie

### Method
POST

### Endpoint
/companies/{companyId}/login/authcookie
```

--------------------------------

### Jobs API

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Endpoints for managing job postings, contracts, products, and related searches.

```APIDOC
## GET /companies/{companyId}/jobs/{jobId}

### Description
Get Job by JobId.

### Method
GET

### Endpoint
/companies/{companyId}/jobs/{jobId}
```

```APIDOC
## POST /jobs/search

### Description
Search for jobs.

### Method
POST

### Endpoint
/jobs/search
```

```APIDOC
## POST /companies/{companyId}/jobs

### Description
Upsert Job and Contract.

### Method
POST

### Endpoint
/companies/{companyId}/jobs
```

```APIDOC
## POST /companies/{companyid}/jobs/search

### Description
Quickfind - Job Search

### Method
POST

### Endpoint
/companies/{companyid}/jobs/search
```

```APIDOC
## POST /companies/{companyId}/jobs/products

### Description
Upsert Job Products.

### Method
POST

### Endpoint
/companies/{companyId}/jobs/products
```

```APIDOC
## POST /companies/{companyId}/jobs/opportunities

### Description
Get jobs and leads.

### Method
POST

### Endpoint
/companies/{companyId}/jobs/opportunities
```

```APIDOC
## POST /companies/{companyId}/jobs/products/details

### Description
Upsert Job Product Details.

### Method
POST

### Endpoint
/companies/{companyId}/jobs/products/details
```

--------------------------------

### Address - Zip Code Lookup

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Retrieve address details based on a Zip Code.

```APIDOC
## GET /companies/{companyid}/address/zipCodeLookup

### Description
Get a list of Address having city, state, Zip code, and county based on a ZipCode.

### Method
GET

### Endpoint
/companies/{companyid}/address/zipCodeLookup

### Parameters
#### Path Parameters
- **companyid** (string) - Required - The ID of the company.

#### Query Parameters
- **zipCode** (string) - Required - The Zip Code to look up.

### Response
#### Success Response (200)
- **addresses** (array) - A list of addresses matching the Zip Code.

#### Response Example
(Response example not provided in source text)
```

--------------------------------

### ActivityReferences API

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0+Marketsharp+CRM+API

Endpoints for retrieving activity references for a company.

```APIDOC
## GET /companies/{companyId}/activities/references

### Description
Retrieves activity references for a specified company.

### Method
GET

### Endpoint
/companies/{companyId}/activities/references

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The unique identifier for the company.

### Response
#### Success Response (200)
- **activityReferences** (array) - A list of activity reference objects.
  - **id** (string) - The ID of the activity reference.
  - **name** (string) - The name of the activity reference.

#### Response Example
```json
{
  "activityReferences": [
    {
      "id": "ref-001",
      "name": "Sales Call"
    }
  ]
}
```
```

--------------------------------

### LeadCaptures API

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Endpoints for retrieving and filtering lead capture data, including custom and iCapture types.

```APIDOC
## GET /companies/{companyId}/leadcaptures/custom

### Description
List all custom lead captures

### Method
GET

### Endpoint
/companies/{companyId}/leadcaptures/custom
```

```APIDOC
## GET /companies/{companyId}/leadcaptures/iCapture

### Description
List iCapture lead captures

### Method
GET

### Endpoint
/companies/{companyId}/leadcaptures/iCapture
```

```APIDOC
## POST /leadcaptures/{applicationInternalName}/contacts/filter

### Description
List global active contacts submitted by lead capture app since latest updated date/time

### Method
POST

### Endpoint
/leadcaptures/{applicationInternalName}/contacts/filter
```

```APIDOC
## POST /companies/{companyId}/leadcaptures/{applicationInternalName}/contacts/filter

### Description
List active contacts submitted by lead capture app since latest updated date/time

### Method
POST

### Endpoint
/companies/{companyId}/leadcaptures/{applicationInternalName}/contacts/filter
```

--------------------------------

### Test Exception API

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

An endpoint to test exception handling by throwing specified exceptions.

```APIDOC
## GET /test/exception/{exceptionType}

### Description
Tests various exception types by throwing the specified exception.

### Method
GET

### Endpoint
/test/exception/{exceptionType}

### Parameters
#### Path Parameters
- **exceptionType** (string) - Required - The type of exception to throw.
```

--------------------------------

### Listen360 Survey API

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Endpoint for creating Listen360 surveys for a specific job.

```APIDOC
## POST /companies/{companyId}/listen360/jobs/{jobId}

### Description
Creates a Listen360 survey for a given job.

### Method
POST

### Endpoint
/companies/{companyId}/listen360/jobs/{jobId}

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.
- **jobId** (string) - Required - The ID of the job for which to create the survey.
```

--------------------------------

### Appointments Endpoints

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0+Marketsharp+CRM+API

Endpoints for managing and retrieving appointment data.

```APIDOC
## GET /appointments/reasons

### Description
List active appointment result reasons - Deprecated.

### Method
GET

### Endpoint
/appointments/reasons
```

```APIDOC
## GET /appointments/results

### Description
List active appointment results - Deprecated.

### Method
GET

### Endpoint
/appointments/results
```

```APIDOC
## GET /appointments/{appointmentId}

### Description
Retrieve an appointment - Deprecated.

### Method
GET

### Endpoint
/appointments/{appointmentId}
```

```APIDOC
## GET /companies/{companyId}/appointments/results/active

### Description
List active appointment results.

### Method
GET

### Endpoint
/companies/{companyId}/appointments/results/active
```

```APIDOC
## GET /companies/{companyId}/appointments/{appointmentId}

### Description
Retrieve an appointment.

### Method
GET

### Endpoint
/companies/{companyId}/appointments/{appointmentId}
```

```APIDOC
## GET /companies/{companyId}/appointments/resultreasons/active

### Description
List active appointment result reasons.

### Method
GET

### Endpoint
/companies/{companyId}/appointments/resultreasons/active
```

```APIDOC
## POST /appointments/search

### Description
Filter for appointments - Deprecated.

### Method
POST

### Endpoint
/appointments/search
```

```APIDOC
## POST /appointments/resultAppt

### Description
Result an appointment - Deprecated.

### Method
POST

### Endpoint
/appointments/resultAppt
```

```APIDOC
## POST /companies/{companyId}/appointments/filter

### Description
Filter for appointments.

### Method
POST

### Endpoint
/companies/{companyId}/appointments/filter
```

```APIDOC
## POST /companies/{companyId}/appointments/{appointmentId}/result

### Description
Result an appointment.

### Method
POST

### Endpoint
/companies/{companyId}/appointments/{appointmentId}/result
```

--------------------------------

### ListPermissions API

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0+Marketsharp+CRM+API

Endpoints for managing employee list permissions.

```APIDOC
## GET /companies/{companyId}/listpermissions/{permissionName}/employees

### Description
List all employees that have a specified list permission within a company.

### Method
GET

### Endpoint
/companies/{companyId}/listpermissions/{permissionName}/employees

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.
- **permissionName** (string) - Required - The name of the permission.
```

```APIDOC
## GET /companies/{companyId}/listpermissions/{permissionName}/employees/active

### Description
List active employees that have the specified permission within a company.

### Method
GET

### Endpoint
/companies/{companyId}/listpermissions/{permissionName}/employees/active

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.
- **permissionName** (string) - Required - The name of the permission.
```

--------------------------------

### PaySimple API

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0+Marketsharp+CRM+API

Endpoints for integrating with PaySimple for payment processing and customer management.

```APIDOC
## GET /companies/{companyId}/paysimple/IsSandbox

### Description
Check if PaySimple credentials are for Sandbox or Production environment.

### Method
GET

### Endpoint
/companies/{companyId}/paysimple/IsSandbox

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.
```

```APIDOC
## GET /companies/{companyId}/paysimple/checkouttoken

### Description
Get a PaySimple Checkout Token.

### Method
GET

### Endpoint
/companies/{companyId}/paysimple/checkouttoken

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.
```

```APIDOC
## GET /companies/{companyId}/paysimple/merchant/paymentoptions

### Description
Get Merchant Payment Options from PaySimple.

### Method
GET

### Endpoint
/companies/{companyId}/paysimple/merchant/paymentoptions

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.
```

```APIDOC
## GET /companies/{companyId}/paysimple/customers/{customerId}/token

### Description
Get a PaySimple Customer Token.

### Method
GET

### Endpoint
/companies/{companyId}/paysimple/customers/{customerId}/token

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.
- **customerId** (string) - Required - The ID of the customer.
```

```APIDOC
## GET /companies/{companyId}/paysimple/contact/{contactId}/customers

### Description
List PaySimple Customers associated with a Contact.

### Method
GET

### Endpoint
/companies/{companyId}/paysimple/contact/{contactId}/customers

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.
- **contactId** (string) - Required - The ID of the contact.
```

```APIDOC
## GET /companies/{companyId}/paysimple/customers/{customerId}/accounts

### Description
Get PaySimple Customer Accounts.

### Method
GET

### Endpoint
/companies/{companyId}/paysimple/customers/{customerId}/accounts

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.
- **customerId** (string) - Required - The ID of the customer.
```

```APIDOC
## PUT /companies/{companyId}/paysimple/account/ach

### Description
Update ACH Account Information in PaySimple.

### Method
PUT

### Endpoint
/companies/{companyId}/paysimple/account/ach

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.

### Request Body
(Schema not provided in source text)
```

```APIDOC
## PUT /companies/{companyId}/paysimple/account/creditcard

### Description
Update Credit Card information in PaySimple.

### Method
PUT

### Endpoint
/companies/{companyId}/paysimple/account/creditcard

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.

### Request Body
(Schema not provided in source text)
```

```APIDOC
## POST /companies/{companyId}/paysimple/payment

### Description
Make a Payment through PaySimple.

### Method
POST

### Endpoint
/companies/{companyId}/paysimple/payment

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.

### Request Body
(Schema not provided in source text)
```

```APIDOC
## POST /companies/{companyId}/paysimple/contactJobSearch

### Description
Perform a Contact Job Search using PaySimple.

### Method
POST

### Endpoint
/companies/{companyId}/paysimple/contactJobSearch

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.

### Request Body
(Schema not provided in source text)
```

```APIDOC
## POST /companies/{companyId}/paysimple/reconciliation/payments

### Description
Get PaySimple payment reconciliation records.

### Method
POST

### Endpoint
/companies/{companyId}/paysimple/reconciliation/payments

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.

### Request Body
(Schema not provided in source text)
```

```APIDOC
## POST /companies/{companyId}/paysimple/reconciliation/matchpayment

### Description
Reconcile a PaySimple payment.

### Method
POST

### Endpoint
/companies/{companyId}/paysimple/reconciliation/matchpayment

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.

### Request Body
(Schema not provided in source text)
```

```APIDOC
## POST /companies/{companyId}/paysimple/reconciliation/unlinkpayment

### Description
Unlink a PaySimple payment.

### Method
POST

### Endpoint
/companies/{companyId}/paysimple/reconciliation/unlinkpayment

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.

### Request Body
(Schema not provided in source text)
```

```APIDOC
## POST /companies/{companyId}/paysimple/customers/{customerId}/contacts/{contactId}

### Description
Link a PaySimple Customer to a Contact.

### Method
POST

### Endpoint
/companies/{companyId}/paysimple/customers/{customerId}/contacts/{contactId}

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.
- **customerId** (string) - Required - The ID of the PaySimple customer.
- **contactId** (string) - Required - The ID of the contact.
```

--------------------------------

### PriceBook API

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0+Marketsharp+CRM+API

Endpoints for retrieving price book information.

```APIDOC
## GET /pricebook

### Description
List all items in the price book. This endpoint is deprecated.

### Method
GET

### Endpoint
/pricebook
```

```APIDOC
## GET /companies/{companyId}/pricebook

### Description
List all items in the price book for a specific company.

### Method
GET

### Endpoint
/companies/{companyId}/pricebook

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company.
```

--------------------------------

### PrintFile API Endpoints

Source: https://restapi.marketsharpm.com/?urls.primaryName=2.0%20Marketsharp%20CRM%20API

Endpoints for managing print files and work orders.

```APIDOC
## GET /companies/{companyid}/printfile/workorder/templates

### Description
Gets the available work order templates

### Method
GET

### Endpoint
/companies/{companyid}/printfile/workorder/templates
```

```APIDOC
## GET /companies/{companyid}/printfile/workorder/{processTypeStepOid}

### Description
Opens the existing work order for editing

### Method
GET

### Endpoint
/companies/{companyid}/printfile/workorder/{processTypeStepOid}
```

```APIDOC
## GET /companies/{companyid}/printfile/workorder/{processTypeStepOid}/exists

### Description
Checks if a work order exists

### Method
GET

### Endpoint
/companies/{companyid}/printfile/workorder/{processTypeStepOid}/exists
```

```APIDOC
## POST /companies/{companyid}/printfile/workorder

### Description
Creates a string url to open the print file shim to create a work order

### Method
POST

### Endpoint
/companies/{companyid}/printfile/workorder
```

```APIDOC
## DELETE /companies/{companyid}/printfile/workorder/{processTypeStepOid}/delete

### Description
This will delete the work order by the processTypeStepOid

### Method
DELETE

### Endpoint
/companies/{companyid}/printfile/workorder/{processTypeStepOid}/delete
```
Tokens:
Raw