openapi: 3.0.3 info: title: Copper Developer API description: >- The Copper Web API allows you to access and build your own applications that interact with Copper in more complex ways than the integrations we provide out of the box. The Copper Developer API ("Dev API") provides a RESTful interface with JSON-formatted responses to access most Copper resources. We are continuously working on expanding our API functionality, so stay tuned! Authentication =================== The Dev API uses a token based authentication. You have to include the token in the header of every request, along with the email address of the user who generated the token. Each Copper user can generate API keys and can have multiple valid tokens at the same time. Admins can see all user generated tokens. To generate an API token, in the Copper web app go to System settings > API Keys and click the 'CREATE A KEY' button. Copper allows you to label each key for its unique purpose. You'll need to generate an API key to make an API Request. Requests ======== **Encryption** All requests must be sent using HTTPS with TLS 1.2 or higher. Please make sure your developer tools support this version of TLS as older versions or SSL are not supported for security reasons. **Headers** All Copper API calls must include the following headers to authenticate the request: | Key | Value | | ---------------- | ---------------------------- | | X-PW-AccessToken | _API Key_ | | X-PW-Application | "developer_api" | | X-PW-UserEmail | _Email address of token owner_ | | Content-Type | "application/json" | **Body** For PUT or POST requests (e.g. create, update, search), the request parameters must be provided as JSON in the request body. **Rate limits** All API calls are limited to 180 requests every minute. Once either limit has been reached, calls will return and error with status code 429. This rate limit is evaluated on a rolling window basis. Responses ========= Responses use the customary [HTTP status codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes), with the most typical ones being: | Code | Meaning | | ---------------------- | --------------------- | | *Successful Responses* | | | 200 | OK | | *Error Responses* | | | 400 | Bad Request | | 401 | Unauthorized | | 429 | Too many requests | | 500 | Internal Server Error | Each of the entities in the Dev API (Leads, People, etc.) has a '/search' endpoint. For requests sent to '/search' endpoints, the response header contains a field called 'X-PW-TOTAL'. This value represents an upper bound of the total number of records returned in the search query. It allows the developer to estimate roughly how long it would take to extract the data when the results are paginated (See Paginating Search Results section). Search ====================== **Search by Phone Number** There are two types of phone number search, fuzzy and partial. The difference is in the way the input is permuted prior to search. In general, fuzzy search returns more results, but partial search returns results that are closer to what the user entered. Let's illustrate from an example. Suppose the user enters "408-555-1234". In either search, non-numeric characters are stripped first. Partial Search: "4085551234" is searched in the database for all records that have phone numbers that end in "4085551234". This includes entities with phone numbers such as "4085551234", "1-4085551234", "123-4085551234", etc. Fuzzy Search: "4085551234" is permuted first by stripping 1-6 digits from the beginning of the sequence. If the resulting sequence is less than 6 digits long, it is dropped from the search. In this case, the search string set is "4085551234", "085551234", "85551234", "5551234", "551234". Any records in the database where the phone number ends in the string set is returned. The query results form fuzzy match includes results from the partial search and many more ambiguous results. For example, records with phone number such as "5105551234" would also be returned. To designate the type of phone number search, specify the "match" field when entering the phone number in the search request body. E.g., { "phone_number": { "value": "5551234", "match": "partial" } } Match scheme is partial if the input string is 6 digits or fewer. For an input string 7 digits or more, the default behavior is fuzzy search if a match scheme is not specified. Paginating search results ====================== Our /search endpoints return multiple records per response. How many records are included in a single response (=page size) is determined by an optional search parameter called "page_size". The default value for "page_size" is 20, and its value can be set to any integer between 1 and 200. When the search criteria match more records than what fits on a single page then you have to paginate the search results using one of the following strategies in order to get all the records that match your search. Strategy 1: Calculate the number of pages --------------------------- Every response from a /search endpoint has a field in the response header called 'X-PW-TOTAL'. It shows an upper bound of the total number of records that match the search criteria. To calculate the number of pages to cycle thru, divide the total number of records by the page size. For the sake of example, let's assume that the page size is 200 and the total number of records is 775. The number of pages is 775/200 = 3.875 which rounded up to the nearest integer gives us 4 pages. Now, to cycle thru the pages we need to set the "page_number" parameter in the request to 1 initially, and then send additional requests for the subsequent pages. The request header will look like this: _For the first page_ { ... "page_size": 200, "page_number": 1 ... } _For the second page_ { ... "page_size": 200, "page_number": 2 ... } and so on. This strategy has one caveat; if records are added/modified in the system between the time when the header field is evaluated and when the actual pages are requested then those records may be included or omitted in/from the results incorrectly. Strategy 2: Count the records on each page ------------------ In this scenario, we send a search request and specify the first page, by setting "page_number" to 1. Then use a logic that performs the following evaluation on the response. 1. Count the number of records in the response 2. Check if the record count equals the page_size 3. a. If the record is less than the page size then we are on the last page and we can stop paginating 3. b. If the record count equals the page size then increase "page_size" by one, send another request and start over with this evaluation logic. Using the same example as above, with a page size of 200 and 775 total records the evaluation would go down as follows _Page 1_ { ... "page_size": 200, "page_number": 1 ... } The response will have 200 records which equals the page size, so let's continue requesting. _Page 2_ { ... "page_size": 200, "page_number": 2 ... } The response will have 200 records which equals the page size, so let's continue requesting. The 3rd page will have identical results. _Page 4 (last page)_ { ... "page_size": 200, "page_number": 4 ... } The response will have 175 records, which is LESS than the page size, which tells us we are on the last page and we can stop paginating. Remember to sort you search results! ------------------- It is highly recommended that you sort the results you get back from a /search endpoint. This ensures that records are returned in a consistent fashion across requests. One common sorting scenario is to sort records by the date they were last updated, in a descending order. For this sorting please add the following parameters to the search request: { ... "sort_by": "date_modified", "sort_direction": "desc" ... } Best practices ============== **Date formats** Date formats are in Unix Timestamp format and values are set and returned as 10 digit long integers (For example {"date_created": 1483988828}). There are a few notable exceptions, however. The "close_date" on Opportunities, Task Due Dates and Reminder dates, and custom date fields use an ISO "mm/dd/yyyy" format for setting and returning date values. **The API respects Team Permissions** A user's access to records in Copper may be restricted by Team Permission settings. The Dev API respects team permissions. It is recommended to use the API credentials of an admin user when using the Dev API because Admins have unrestricted data access. **Create a Developer User** If you use the Dev API to create records in Copper, it is advisable to create a separate (non-personal) user just for integration purposes. Generate API credentials for this user and use those for integration. This way records created thru the Dev API will be owned by this integration user and can be filtered accordingly. **Entity ID scopes** Unique identifiers are unique within the scope of a single resource type. For example, a given identifier for a Lead will never be assigned to a different Lead, but a different resource such as a Person could use the same identifier. **File Upload** Currently, the Developer API does not allow for file uploads. There is a workaround available. 1. Create a custom URL field. 2. Upload your file to Google Drive. 3. Push the created file link into your Copper custom URL field. Embedded Apps =================== Embedded Integrations lets you easily display an integration you've built in the Copper web app. [Working with our SDK](https://docs.copper.com/pw-app-sdk/), you can create and embed your own app in Copper in just a few clicks. To join the beta, click [here](https://docs.google.com/forms/d/1tEgGLqAeYQ2PFmkaiwGEBRNGcpDBrK7zKvd2XXtqoIw/viewform?edit_requested=true). For more info on embedded apps, please go [here](https://support.copper.com/hc/en-us/articles/360001624708-Working-with-Embedded-Integrations-BETA-). Appendix ============================ **Categories** When creating or updating entities such as leads or people, there are fields where value and category can be specified. These fields include email, phone, social, and website. Below are the valid categories for each of these fields. | Field | Categories | |-----------|-----------------------------------------------------------------------------------------------| | Email | work, personal, other | | Phone | mobile, work, home, other | | Social | linkedin, twitter, googleplus, facebook, youtube, quora, foursquare, klout, gravatar, other | | Website | work, personal, other | Getting Support ============================ For code samples, please visit [Code Samples](https://support.copper.com/hc/en-us/articles/115000816826-Code-samples-and-tips). For API questions and support, please [Submit a request](https://support.prosperworks.com/hc/en-us/requests/new) or post your question in our [Developer Forum](https://support.prosperworks.com/hc/en-us/community/topics/201113143-ProsperWorks-API-Developer-Forum). version: 1.0.0 contact: {} x-api-status-urls: false x-konfig-ignore: potential-incorrect-type: true servers: - url: '{{base_url}}' - url: https://ali-userassets-production.s3.amazonaws.com - url: https://your.endpoint.here tags: - name: Custom Fields - description: >- An Opportunity is a potential business deal. The Opportunities API allows you to create, view, delete and update your Opportunities. You can retrieve individual Opportunities, list all Opportunities, or use search filters to view subsets of your Opportunities. **Opportunity Properties** | Field | Type | Details | | ------------------------------------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------ | | id | number | Unique identifier for the Opportunity. | | name* | string | The name of the Opportunity. | | assignee_id | number | Unique identifier of the User that will be the owner of the Opportunity. | | close_date | string | The expected close date of the Opportunity in MM/DD/YYYY or DD/MM/YYYY format. | | company_id | string | The unique identifier of the primary Company with which the Opportunity is associated. | | company_name | string | The name of the primary Company with which the Opportunity is associated. | | customer_source_id | number | Unique identifier of the Customer Source that generated this Opportunity. | | details | string | Description of the Opportunity. | | loss_reason_id | number | If the Opportunity's status is "Lost", the unique identifier of the loss reason that caused this Opportunity to be lost. | | monetary_value | number | The monetary value of the Opportunity. | | pipeline_id | number | The unique identifier of the Pipeline in which this Opportunity is. | | primary_contact_id* | number | The unique identifier of the Person who is the primary contact for this Opportunity. | | priority | string_enum | The priority of the Opportunity. Valid values are: "None", "Low", "Medium", "High". | | pipeline_stage_id | number | The unique identifier of the Pipeline Stage of the Opportunity. | | status | string_enum | The status of the Opportunity. Valid values are: "Open", "Won", "Lost", "Abandoned". | | tags | list | An array of the tags associated with the Opportunity, represented as strings. | | win_probability | number | The expected probability of winning the Opportunity. Valid values are [0-100](inclusive). | | date_created | number | A Unix timestamp representing the time at which this Opportunity was created. | | date_modified | number | A Unix timestamp representing the time at which this Opportunity was last modified. | | custom_fields[] | list | An array of custom field values belonging to the Opportunity. | | custom_fields[].custom_field_definition_id | number | The id of the Custom Field Definition for which this Custom Field stores a value. | | custom_fields[].value | mixed | The value (number, string, option id, or timestamp) of this Custom Field. | | \* indicates a required field | | | name: 5. Opportunities - description: >- Use custom fields to customize Copper. Custom fields are available on all main objects, Leads, People, Companies, Opportunities, Project and Tasks. To learn more, please visit this [help article](https://support.copper.com/hc/en-us/articles/360000558631-Working-with-Custom-Fields). name: General - description: >- A Lead is an individual or a company that's interested in your products or services. It's a "catch-all" object that contains information about the contact, the company and the project in one. When Leads are qualified, they are usually converted to a Person, Company and Opportunity. **Lead Properties** | Field | Type | Details | | ------------------------------------------ | ------------- | --------------------------------------------------------------------------------------------------------------- | | id | number | Unique identifier for the Lead. | | name* | string | The first and last name of the Lead. | | address | address | An encapsulation of the Lead's street, city, state, postal code, and country. | | assignee_id | number | Unique identifier of the User that will be the owner of the Lead. | | company_name | string | The name of the company to which the Lead belongs. | | customer_source_id | number | Unique identifier of the Customer Source that generated this Lead. | | details | string | Description of the Lead. | | email | email_address | An encapsulation of the Lead's email address and category. | | monetary_value | number | The expected monetary value of business with the Lead | | phone_numbers[] | list | An array of phone numbers belonging to the Lead. | | phone_numbers[].number | string | A phone number. | | phone_numbers[].category | string | The category of the phone number. | | socials[] | list | An array of social profiles belonging to the Lead. | | socials[].url | string | The URL of a social profile. | | socials[].category | string | The category of the social profile. | | status | string_enum | A string representing the status of the Lead. Valid values are: "New", "Unqualified", "Contacted", "Qualified". | | tags | list | An array of the tags associated with the Lead, represented as strings. | | title | string | The professional title of the Lead. | | websites[] | list | An array of websites belonging to the Lead. | | websites[].url | string | The URL of a website. | | websites[].category | string | The category of the website. | | custom_fields[] | list | An array of custom field values belonging to the Lead. | | custom_fields[].custom_field_definition_id | number | The id of the Custom Field Definition for which this Custom Field stores a value. | | custom_fields[].value | mixed | The value (number, string, option id, or timestamp) of this Custom Field. | | date_created | number | A Unix timestamp representing the time at which this Lead was created. | | date_modified | number | A Unix timestamp representing the time at which this Lead was last modified. | |\* indicates a required field| | | name: 2. Leads - description: >- A Person is an individual with whom you communicate. The People API allows you to create, view, delete and update your People. You can retrieve individual People, list all People, or use search filters to view subsets of your People. **Person Properties** | Field | Type | Details | | --------------------------- | ------- | --------------------------------------------------------------------------------- | | id | number | Unique identifier for the Person. | | name* | string | The first and last name of the Person. | | address | address | An encapsulation of the Person's street, city, state, postal code, and country. | | assignee_id | number | Unique identifier of the User that will be the owner of the Person. | | company_id | string | The unique identifier of the primary Company with which the Person is associated. | | company_name | string | The name of the primary Company with which the Person is associated. | | contact_type_id | number | The unique identifier of the Contact Type of the Person. | | details | string | Description of the Person. | | emails[] | list | An array of email addresses belonging to the Person. | | emails[].email | string | An email address. | | emails[].category | string | The category of the email address. | | phone_numbers[] | list | An array of phone numbers belonging to the Person. | | phone_numbers[].number | string | A phone number. | | phone_numbers[].category | string | The category of the phone number. | | socials[] | list | An array of social profiles belonging to the Person. | | socials[].url | string | The URL of a social profile. | | socials[].category | string | The category of the social profile. | | tags | list | An array of the tags associated with the Person, represented as strings. | | title | string | The professional title of the Person. | | websites[] | list | An array of websites belonging to the Person. | | websites[].url | string | The URL of a website. | | websites[].category | string | The category of the website. | | date_created | number | A Unix timestamp representing the time at which this Person was created. | | date_modified | number | A Unix timestamp representing the time at which this Person was last modified. | | custom_fields[] | list | An array of custom field values belonging to the Person. | | custom_fields[] | | | | .custom_field_definition_id | number | The id of the Custom Field Definition for which this Custom Field stores a value. | | custom_fields[] | | | | .value | mixed | The value (number, string, option id, or timestamp) of this Custom Field. | | \* indicates a required field | | | *Please note that* ***email address is a unique key*** *for People and no two records can have the same email address. If you try to create a new Person with an existing email address, then your request will fail.* name: 3. People - description: >- A Company is an organization with which you communicate. The Companies API allows you to create, view, delete and update your Companies. You can retrieve individual Companies, list all Companies, or use search filters to view subsets of your Companies. **Company Properties** | Field | Type | Details | | ------------------------------------------ | ------- | --------------------------------------------------------------------------------- | | id | number | Unique identifier for the Company. | | name* | string | The name of the Company. | | address | address | An encapsulation of the Company's street, city, state, postal code, and country. | | assignee_id | number | Unique identifier of the User that will be the owner of the Company. | | contact_type_id | number | The unique identifier of the Contact Type of the Company. | | details | string | Description of the Company. | | email_domain | string | The domain to which email addresses for the Company belong. | | phone_numbers[] | list | An array of phone numbers belonging to the Company. | | phone_numbers[].number | string | A phone number. | | phone_numbers[].category | string | The category of the phone number. | | socials[] | list | An array of social profiles belonging to the Company. | | socials[].url | string | The URL of a social profile. | | socials[].category | string | The category of the social profile. | | tags | list | An array of the tags associated with the Company, represented as strings. | | websites[] | list | An array of websites belonging to the Company. | | websites[].url | string | The URL of a website. | | websites[].category | string | The category of the website. | | date_created | number | A Unix timestamp representing the time at which this Company was created. | | date_modified | number | A Unix timestamp representing the time at which this Company was last modified. | | custom_fields[] | list | An array of custom field values belonging to the Company. | | custom_fields[].custom_field_definition_id | number | The id of the Custom Field Definition for which this Custom Field stores a value. | | custom_fields[].value | mixed | The value (number, string, option id, or timestamp) of this Custom Field. | | \* indicates a required field | | | *Please note that* ***email domain is a unique key*** *for Companies and no two records can have the same domain name. If you try to create a new Company with an existing email domain, then your request will fail.* name: 4. Companies - description: >- A Project is a large set of work which needs to be completed. The Projects API allows you to create, view, delete and update your Projects. You can retrieve individual Projects, list all Projects, or use search filters to view subsets of your Projects. **Project Properties** | Field | Type | Details | | ------------------------------------------ | ----------- | --------------------------------------------------------------------------------- | | id | number | Unique identifier for the Project. | | name* | string | The name of the Project. | | related_resource | identifier | The primary related resource for the Project. | | assignee_id | number | Unique identifier of the User that will be the owner of the Project. | | status | string_enum | The status of the Project. Valid values are: "Open", "Completed". | | details | string | Description of the Project. | | tags | list | An array of the tags associated with the Project, represented as strings. | | custom_fields[] | list | An array of custom field values belonging to the Project. | | custom_fields[].custom_field_definition_id | number | The id of the Custom Field Definition for which this Custom Field stores a value. | | custom_fields[].value | mixed | The value (number, string, option id, or timestamp) of this Custom Field. | | date_created | number | A Unix timestamp representing the time at which this Project was created. | | date_modified | number | A Unix timestamp representing the time at which this Project was last modified. | | \* indicates a required field | | | name: 6. Projects - description: >- A Task is a small unit of work which needs to be completed. The Tasks API allows you to create, view, delete and update your Tasks. You can retrieve individual Tasks, list all Tasks, or use search filters to view subsets of your Tasks. **Task Properties** | Field | Type | Details | | ------------------------------------------ | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | id | number | Unique identifier for the Task. | | name* | string | The name of the Task. | | related_resource | identifier | The primary related resource for the Task. | | assignee_id | number | Unique identifier of the User that will be the owner of the Task. | | due_date | number | The date on which the Task is due. | | reminder_date | number | The date on which to receive a reminder about the Task. | | completed_date | number | The date on which the Task was completed. This is automatically set when the status changes from Open to Completed, and cannot be set directly. | | priority | string_enum | The priority of the Task. Valid values are: "None", "High". | | status | string_enum | The status of the Task. Valid values are: "Open", "Completed". | | details | string | Description of the Task. | | tags | list | An array of the tags associated with the Task, represented as strings. | | custom_fields[] | list | An array of custom field values belonging to the Task. | | custom_fields[].custom_field_definition_id | number | The id of the Custom Field Definition for which this Custom Field stores a value. | | custom_fields[].value | mixed | The value (number, string, option id, or timestamp) of this Custom Field. | | date_created | number | A Unix timestamp representing the time at which this Task was created. | | date_modified | number | A Unix timestamp representing the time at which this Task was last modified. | | \* indicates a required field | | | name: 7. Tasks - description: > Copper keeps a record of activities for People, Leads, Opportunities, and Companies. The Activities API allows you to view, create, edit, and delete activities. Activities behave uniquely in that deleted activities can be accessed through the API. However, they will appear only as stubs, identical to the response returned by the delete method, and cannot be modified. Only "User" type Activities can be created or modified using the developer API. "System" type Activities are read-only. **Activity Properties** | Field | Type | Details | | ------------- | ------------- | ------------------------------------------------------------------------------------ | | id | number | Unique identifier for the Activity. | | type* | activity_type | The Activity Type of this Activity. | | parent* | identifier | The Identifier of the resource to which this Activity belongs. | | details* | string | When applicable, the text body of this Activity. | | user_id | number | When applicable, the id of the User who performed this Activity. | | activity_date | number | A Unix timestamp representing the time at which this Activity took place. | | old_value | object | When applicable, the value of a resource's property before this Activity took place. | | new_value | object | When applicable, the value of a resource's property after this Activity took place. | | \* indicates a required field | | | name: 8. Activities - description: > Webhooks allow systems integrated with Copper to receive near real-time notification of certain events so that data updates and workflows can be triggered. Webhook concepts ----- **Subscription** Register a URL that notifications will be sent to when a specific event type occurs. **Event** A specific action in Copper that triggers a notification. **Notification** The object delivered by an https request (webhook) to the specified URL. Event Types ----- The following events are available for subscription: - **Create** = a new record is created - **Update** = any field in the existing entity record is changed. Excludes: new entity relationships, new Activity or any change in meta data - **Delete** = an existing record is removed Events are available for the different entity types as follows. | Record Type | Create | Update | Delete | type | | ----------- | ------ | ------ | ------ | ----- | | Lead | yes | yes | yes | "lead"| | Person | yes | yes | yes | "person"| | Company | yes | yes | yes | "company" | | Opportunity | yes | yes | yes | "opportunity"| | Project | yes | yes | yes | "project"| | Task | yes | yes | yes | "task"| | Activity | yes | yes | yes | "activity_log"| Technical considerations ----- **Subscription count** You may have up to 100 active subscriptions per account. **Rate limits** The number of notifications sent are bound by the following limits: - 600 notifications per minute per account - 1,800 notifications per account for every 10 minutes **Multi-event notifications** Our notifications always send an array with the IDs of the records involved. The array contains at least 1 ID and may contain up to 30 ID's in a single notification. If more than 30 records are affected then we send multiple notifications, each with up to 30 IDs. Each notification counts as a single request towards the rate limit, regardless of the number of IDs it contains. **Retries** Our notifications are fired not more than once per event, and we do not retry them, regardless of the status returned by the notification endpoint. **HTTPS only** For security reasons only https:// endpoints are accepted for the notification URL. Webhook properties ---- | Field | Type | Details | | -------------- | ---------- | ----------------------------------------------------------- | | id | Identifier | The unique ID of the subscription | | target | String | The URL where the notification will be sent | | type | String | The entity type on which the event occurs | | event | String | The type of event that triggers the notification "new","update","delete" | | secret | Hash | (Optional) Hash that stores any information (e.g. for authentication) to pass to the webhook event, in the form { "key1": "value1", "key2": "value2", ... } | | created_at | Integer | The date when the subscription was cretaed | name: Webhooks - name: File Upload - description: > Account ======= An **Account** is created when you sign up with Copper. **Users** that you invite will all be members of this Account. In Copper, customer organizations are called "Companies." **Account Properties** | Field | Type | Details | | ----- | ------ | ---------------------------------- | | id | number | Unique* identifier for the Account | | name | string | Name of the account | **User Properties** | Field | Type | Details | | ----- | ------ | ------------------------------- | | id | number | Unique* identifier for the User | | name | string | The User's full name | | email | string | The User's email address | *A note on ids: Unique identifiers are unique within the scope of a single resource type. For example, a given identifier for a Lead will never be assigned to a different Lead, but a different resource such as a Person could use the same identifier.* name: 1. Account and Users - description: >- Use connect fields to create custom relationships between records. Common examples include keeping track of the relationship between parent/child companies, people to people referrals, assignments, managers, investors and more. For more use cases, please refer to this [help article](https://support.copper.com/hc/en-us/articles/360001739248-Working-with-Connect-Fields). name: Connect Fields - description: >- Copper supports relating Leads, People, Companies, Opportunities, Projects and Tasks to each other. In the web and mobile applications, these relationships are typically shown in a "Related Items" sections. The Related Items API allows you to relate resources to each other, to view a resource's related items, and to remove relationships between resources. All relationships are bidirectional, i.e. relating Resource A to Resource B is functionally equivalent to relating Resource B to Resource A. Relationships can only exist between certain types of entities, and additional restrictions may apply. The following are the allowed relationships between Copper resources: - Leads: Tasks - People: Companies (limit 1), Opportunities, Tasks, Projects - Companies: Opportunities, People, Tasks, Projects - Opportunities: Companies, People, Tasks, Projects - Projects: Companies, People, Opportunities, Tasks - Tasks: Companies, People, Opportunities, Leads, Projects (limit 1 total) The request URLs for each of these operations are constructed as follows. To find all records related to an entity (e.g. leads), the API endpoint is: https://api.copper.com/developer_api/v1/leads/{{example_lead_id}}/related To find all entities (e.g. tasks) related to a particular entity (e.g. leads), the API endpoint is: https://api.copper.com/developer_api/v1/leads/{{example_lead_id}}/related/tasks The entities leads and tasks in the above examples can be replaced with any entity types that are related to each other (see above for the complete list). **Notes** Related Items may be added or removed, but not modified. (To "modify" a Related Item, remove it and add a new one.) The Related Items API uses Identifiers (as opposed to full objects) to uniquely identify related items. name: Related Items paths: /account: get: tags: - 1. Account and Users summary: Fetch Account Details operationId: 1AccountAndUsers_getDetails description: Fetch Account Details parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: Account Details headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 14 Mar 2017 21:43:34 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTcxYTBiMzc5NThlOWEzZGY1YWVkNzFhYmQxZDNhNGI2BjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMXI5cTh0YVUzczhDcUdTN1JqM0ozT0cwN2JFbzRUTXBZd3ZzcXVtejhOd0E9BjsARg%3D%3D--601fa0935bd57c2d71757369050a51811ed4f3d0; domain=prosperworks.com; path=/; expires=Wed, 14-Mar-2018 21:43:34 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 75d61c37-262e-45f6-a93b-5a6f278db7a2 X-Runtime: schema: type: string example: '0.130191' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/1AccountAndUsersGetDetailsResponse' examples: Account Details: value: id: 100624 name: Dev API Sandbox /users/{example_user_id}: parameters: - name: example_user_id in: path required: true schema: type: string get: tags: - 1. Account and Users summary: Fetch User by ID operationId: 1AccountAndUsers_getUserById description: Fetch User by ID parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: User headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Thu, 27 Apr 2017 23:29:54 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTcxYTBiMzc5NThlOWEzZGY1YWVkNzFhYmQxZDNhNGI2BjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMXI5cTh0YVUzczhDcUdTN1JqM0ozT0cwN2JFbzRUTXBZd3ZzcXVtejhOd0E9BjsARg%3D%3D--601fa0935bd57c2d71757369050a51811ed4f3d0; domain=prosperworks.com; path=/; expires=Fri, 27-Apr-2018 23:29:54 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: a6db33ac-f6f7-4bec-889f-32e4b25fd098 X-Runtime: schema: type: string example: '0.081110' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/1AccountAndUsersGetUserByIdResponse' examples: User: value: email: ehdb@phpbb.uu.gl id: 159258 name: Demo User /users/search: post: tags: - 1. Account and Users summary: List Users operationId: 1AccountAndUsers_searchUsers description: >- **Parameters** You can include the following parameters in a search request. | Field | Type | Details | Default | | --------------------- | ------ | -------------------------------------------------------------- | ------- | | *Required Parameters* | | | | | -- | | | | | *Optional Parameters* | | | | | page_number | number | The page number (starting with 1) that you would like to view. | 1 | | page_size | number | The number of entries included in a page of results | 20 | parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/1AccountAndUsersSearchUsersRequest' examples: List Users: value: page_size: 200 responses: '200': description: List of Users headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 14 Mar 2017 21:56:33 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTcxYTBiMzc5NThlOWEzZGY1YWVkNzFhYmQxZDNhNGI2BjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMXI5cTh0YVUzczhDcUdTN1JqM0ozT0cwN2JFbzRUTXBZd3ZzcXVtejhOd0E9BjsARg%3D%3D--601fa0935bd57c2d71757369050a51811ed4f3d0; domain=prosperworks.com; path=/; expires=Wed, 14-Mar-2018 21:56:33 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Pw-Total: schema: type: string example: '2' X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: eb9de3ba-c557-4323-bc80-384ea8f4b653 X-Runtime: schema: type: string example: '0.176432' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/1AccountAndUsersSearchUsersResponse' examples: List of Users: value: - email: johndoe@copper.com id: 137658 name: John Doe - email: janesmith@copper.com id: 159258 name: Jane Smith /leads/{example_lead_id}: parameters: - name: example_lead_id in: path required: true schema: type: string get: tags: - 2. Leads summary: Fetch a Lead by ID operationId: 2Leads_getLeadById description: Fetch a Lead by ID parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: Sample Lead headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Fri, 28 Apr 2017 01:10:53 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTcxYTBiMzc5NThlOWEzZGY1YWVkNzFhYmQxZDNhNGI2BjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMXI5cTh0YVUzczhDcUdTN1JqM0ozT0cwN2JFbzRUTXBZd3ZzcXVtejhOd0E9BjsARg%3D%3D--601fa0935bd57c2d71757369050a51811ed4f3d0; domain=prosperworks.com; path=/; expires=Sat, 28-Apr-2018 01:10:53 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: ad27747d-192e-49fd-bd04-349436a59f1f X-Runtime: schema: type: string example: '0.143904' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/2LeadsGetLeadByIdResponse' examples: Sample Lead: value: tags: - tag 1 - tag 2 title: Title address: city: San Francisco country: US postal_code: '94105' state: CA street: 301 Howard St Ste 600 assignee_id: 137658 company_name: Lead's Company custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null customer_source_id: 331241 date_created: 1489018784 date_modified: 1489173601 details: This is a demo description email: category: work email: address@workemail.com first_name: Test id: 8894157 last_name: Lead middle_name: null monetary_value: 100 name: Test Lead phone_numbers: - category: mobile number: 415-999-4321 - category: work number: 415-555-1234 prefix: null socials: - category: facebook url: facebook.com/test_lead status: New status_id: 208231 suffix: null websites: - category: work url: www.workwebsite.com put: tags: - 2. Leads summary: Update a Lead operationId: 2Leads_updateLead description: >- Updates are only applied to fields explicitly specified in the request body. For example, if an update request is made with an empty body, no updates will be made. To remove the value from a field, the request body must specify the target field value as 'null'. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/2LeadsUpdateLeadRequest' examples: Update a Lead: value: custom_fields: - custom_field_definition_id: 184997 value: - 262644 - 262645 details: This is an update responses: '200': description: Update a Lead headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Fri, 22 Dec 2017 21:09:03 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTUyMGI5OGI1Mjk4MDkzZGU2Y2FhNTE3OGU1YjdjY2JlBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMThEdFlvaTN2UjhWN0x3TDVUYy91SEdvQytKZEoyT0RKcU84Yk1rY1hPenM9BjsARg%3D%3D--eb5fefae0104c4fdebce5cc089b5f966f2b38323; domain=prosperworks.com; path=/; expires=Sat, 22-Dec-2018 21:09:03 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: c5b815ca-e83e-455b-b325-96cba9e9a39f X-Runtime: schema: type: string example: '0.467876' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/2LeadsUpdateLeadResponse' examples: Update a Lead: value: tags: - tag 1 - tag 2 title: Title address: city: San Francisco country: US postal_code: '94105' state: CA street: 301 Howard St Ste 600 assignee_id: 137658 company_name: Lead's Company custom_fields: - custom_field_definition_id: 100764 value: A Text Value - custom_field_definition_id: 128735 value: 1511942400 - custom_field_definition_id: 184997 value: - 262644 - 262645 - custom_field_definition_id: 103481 value: null customer_source_id: 331241 date_created: 1489018784 date_last_contacted: null date_modified: 1513976942 details: This is an update email: category: work email: address@workemail.com first_name: Test id: 8894157 interaction_count: 0 last_name: Lead middle_name: null monetary_unit: null monetary_value: 100 name: Test Lead phone_numbers: - category: mobile number: 415-999-4321 - category: work number: 415-555-1234 prefix: null socials: - category: facebook url: facebook.com/test_lead status: New status_id: 208231 suffix: null websites: - category: work url: www.workwebsite.com delete: tags: - 2. Leads summary: Delete a Lead operationId: 2Leads_removeLead description: This request permanently removes a Lead from your Copper account. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: text/plain: examples: Delete a Lead: value: '' schema: description: >- WARNING: Missing schema in media type object. Missing schema has been filled with this AnyType schema. responses: '200': description: leaddel headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Fri, 10 Mar 2017 22:45:18 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTcxYTBiMzc5NThlOWEzZGY1YWVkNzFhYmQxZDNhNGI2BjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMXI5cTh0YVUzczhDcUdTN1JqM0ozT0cwN2JFbzRUTXBZd3ZzcXVtejhOd0E9BjsARg%3D%3D--601fa0935bd57c2d71757369050a51811ed4f3d0; domain=prosperworks.com; path=/; expires=Sat, 10-Mar-2018 22:45:18 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: d780502d-1324-4d50-bb47-49590644b093 X-Runtime: schema: type: string example: '0.247020' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/2LeadsRemoveLeadResponse' examples: leaddel: value: id: 8900677 is_deleted: true /leads: post: tags: - 2. Leads summary: Create a New Lead operationId: 2Leads_createNewLead description: Create a New Lead parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/2LeadsCreateNewLeadRequest' examples: Create a New Lead: value: custom_fields: - custom_field_definition_id: 100764 value: Text fields are 255 chars or less! - custom_field_definition_id: 103481 value: Text area fields can have long text content customer_source_id: 331242 email: category: work email: mylead@noemail.com name: My Lead phone_numbers: - category: mobile number: 415-123-45678 responses: '200': description: Create new Lead headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 08 Aug 2017 02:14:05 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTU0NDE4YTkzZTBhMzg5MGY2MGI5MGU4YWU1YzhjMWQzBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9ra1JiT1k5dWVXTVJvaU5PN3dNWHVBN1NyZnpsWTlGU0ZzcUUwMllDUzQ9BjsARg%3D%3D--94d0bdf1bdc3e1353cfd15afd73dbdbc07d09908; domain=prosperworks.com; path=/; expires=Wed, 08-Aug-2018 02:14:05 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: d01c30d6-4df1-48de-9b01-e5eadb4f2119 X-Runtime: schema: type: string example: '0.542406' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/2LeadsCreateNewLeadResponse' examples: Create new Lead: value: tags: [] title: null address: null assignee_id: null company_name: null custom_fields: - custom_field_definition_id: 100764 value: Text fields are 255 chars or less! - custom_field_definition_id: 103481 value: Text area fields can have long text content - custom_field_definition_id: 128735 value: null customer_source_id: 331242 date_created: 1502158444 date_last_contacted: null date_modified: 1502158444 details: null email: category: work email: mylead@noemail.com first_name: My id: 13244480 interaction_count: 0 last_name: Lead middle_name: null monetary_value: null name: My Lead phone_numbers: - category: mobile number: 415-123-45678 prefix: null socials: [] status: New status_id: 208231 suffix: null websites: [] /leads/upsert: put: tags: - 2. Leads summary: UPSERT a Lead operationId: 2Leads_upsertLead description: >- **Functionality** "Upsert" (update + insert) will atomically do the following: 1. Check for the existence of a Lead matching certain criteria 1. If one exists, update it with the supplied parameters. 1. If not, create a new Lead with the supplied parameters. 1. This is particularly useful to avoid creating duplicate Leads. **Match Criteria** The supported match criteria are: * Name * Email * Custom Fields To match on a Custom Field, the corresponding Custom Field Definition must be available on Leads and included in filters. (These settings may be viewed and edited in the web application via System Settings -> Custom Fields.) **Match Outcomes** Match outcomes are handled as follows: * If no matches are found, create a new Lead. * If exactly one match is found, update that Lead. * If more than one match is found, return a 422 response with the IDs of the matching Leads. * If more than 30 matches are found, return a 422 response without the IDs of the matching Leads. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/2LeadsUpsertLeadRequest' examples: UPSERT a Lead: value: match: field_name: email field_value: mylead@gmail.test properties: email: category: work email: mylead@gmail.test name: My Lead UPSERT a Lead (by custom field): value: match: field_name: custom field_value: custom_field_definition_id: 178384 value: 1 properties: email: category: work email: mylead@gmail.test name: My Lead responses: '200': description: UPSERT a Lead / UPSERT a Leads headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Thu, 30 Nov 2017 01:40:56 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTUyMGI5OGI1Mjk4MDkzZGU2Y2FhNTE3OGU1YjdjY2JlBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMThEdFlvaTN2UjhWN0x3TDVUYy91SEdvQytKZEoyT0RKcU84Yk1rY1hPenM9BjsARg%3D%3D--eb5fefae0104c4fdebce5cc089b5f966f2b38323; domain=prosperworks.com; path=/; expires=Fri, 30-Nov-2018 01:40:56 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: d9f4b6d2-2e4a-4a16-a2f6-5869bd239b95 X-Runtime: schema: type: string example: '0.310257' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/2LeadsUpsertLeadResponse' examples: UPSERT a Lead: value: tags: [] title: null address: null assignee_id: null company_name: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null - custom_field_definition_id: 128735 value: null customer_source_id: null date_created: 1489531171 date_last_contacted: null date_modified: 1512006056 details: null email: category: work email: mylead@gmail.test first_name: My id: 8982702 interaction_count: 0 last_name: Lead middle_name: null monetary_unit: null monetary_value: null name: My Lead phone_numbers: [] prefix: null socials: [] status: New status_id: 208231 suffix: null websites: [] UPSERT a Leads: value: tags: [] title: null address: null assignee_id: null company_name: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null - custom_field_definition_id: 128735 value: null customer_source_id: null date_created: 1489531171 date_last_contacted: null date_modified: 1512006056 details: null email: category: work email: mylead@gmail.test first_name: My id: 8982702 interaction_count: 0 last_name: Lead middle_name: null monetary_unit: null monetary_value: null name: My Lead phone_numbers: [] prefix: null socials: [] status: New status_id: 208231 suffix: null websites: [] /leads/{example_leadconvert_id}/convert: parameters: - name: example_leadconvert_id in: path required: true schema: type: string post: tags: - 2. Leads summary: CONVERT a Lead operationId: 2Leads_convertLeadToPerson description: >- This request creates a Person record from a Lead record. Optionally, a Company and an Opportunity record can be created as well in the same process. The Lead record is removed after it has been converted. | Field | Type | Details | | ----- | ---- | ------- | | person | object | Details about the Person to be created by the Lead conversion. Valid fields are name, contact_type_id, and assignee_id. | company | object | Details about the Company to which the newly created Person will belong. Valid fields are id or name, and they are mutually exclusive. If a Company id is specified, the new Person will belong to that Company. If the name of an existing Company is specified, the new Person will belong to that Company. If a new name is specified, a new Company will be created with that name, and the new Person will belong to that Company. If you explicitly supply an empty string ("") for the company name, then no Company will be created. By default, fuzzy matching will return a list of candidate companies. An optional Boolean field "exact_match" can be specified if the exact company name is known. | opportunity | object | Details about the Opportunity to be created by the Lead conversion. Valid fields are name, pipeline_id, pipeline_stage_id, monetary_value, and assignee_id. If unspecified, no Opportunity will be created. If pipeline_stage_id is unspecified, it will default to the first stage in the pipeline. | parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/2LeadsConvertLeadToPersonRequest' examples: CONVERT a Lead: value: details: opportunity: monetary_value: 1000 name: Demo Project pipeline_id: 213214 pipeline_stage_id: 12345 person: name: John Doe responses: '200': description: Lead Conversion headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Mon, 05 Jun 2017 20:24:28 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJWE4ZTliNTk0ZGMxNWNiYzEwODNlY2VlN2Y1MjVmYTBiBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMWxoSUd0Qi9NUTlsWEtkZUdPa0ZwVER2cGIzL05vdHgybkNzaVlIc29BbTA9BjsARg%3D%3D--829e2135156aa3a2f9b149d54ba6e7d9760b6015; domain=prosperworks.com; path=/; expires=Tue, 05-Jun-2018 20:24:28 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 4cfbf60f-2d27-4c7e-b4d8-b7da0821a6bb X-Runtime: schema: type: string example: '4.285478' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/2LeadsConvertLeadToPersonResponse' examples: Lead Conversion: value: company: tags: [] address: null assignee_id: 137658 contact_type_id: 451490 custom_fields: - custom_field_definition_id: 100764 value: Text fields are 255 chars or less! - custom_field_definition_id: 103481 value: Text area fields can have long text content date_created: 1496694264 date_modified: 1496694264 details: null email_domain: noemail.com id: 13349319 interaction_count: 0 name: Noemail phone_numbers: [] socials: [] websites: [] opportunity: tags: [] assignee_id: null close_date: null company_id: 13349319 company_name: Noemail custom_fields: - custom_field_definition_id: 100764 value: Text fields are 255 chars or less! - custom_field_definition_id: 103481 value: Text area fields can have long text content customer_source_id: null date_created: 1496694264 date_modified: 1496694264 details: '' id: 4417020 interaction_count: 0 loss_reason_id: null monetary_value: 1000 name: Demo Project pipeline_id: 213214 pipeline_stage_id: 987790 primary_contact_id: 27140359 priority: null status: Open win_probability: 0 person: tags: [] title: null address: null assignee_id: null company_id: 13349319 company_name: Noemail contact_type_id: 451492 custom_fields: - custom_field_definition_id: 100764 value: Text fields are 255 chars or less! - custom_field_definition_id: 103481 value: Text area fields can have long text content date_created: 1490045010 date_modified: 1496694264 details: null emails: - category: work email: mylead@noemail.com first_name: My id: 27140359 interaction_count: 0 last_name: Contact middle_name: null name: My Contact phone_numbers: [] prefix: null socials: [] suffix: null websites: [] /leads/search: post: tags: - 2. Leads summary: List Leads (Search) operationId: 2Leads_listLeadsSearch description: >- The /search endpoint provides the ability to list Leads and sort the results by certain parameters. When multiple ciriteria are provided records meeting ALL criteria will be returned (the filtering criteria have an 'AND' relationship). To see examples of search request using the various parameters, click on the `Leads Search` dropdown on the right. Certain fields can be filtered by an empty value, i.e., filter records where the field is not specified. For Leads, these fields are: city, state, postal_code, tags, custom dropdown, custom multi-select fields. For an example of how this works, see `Search Leads by Empty Field`. Some fields (e.g. assignee_ids) can also filter for an empty value by specifying -2 as the ID. To search by custom fields, see `Search Entity by Custom Field` under `Custom Fields` folder. To change the number of records returned, change the "page_size" parameter. E.g., specify 200 for a page size of 200 records. | Field | Type | Details | Default | | ------------------------- | --------- | ----------------------------------------------------------------------------- | ------- | | page_number | number | The page number (starting with 1) that you would like to view. | 1 | | page_size | number | The number of entries included in a page of results | 20 | | sort_by | string | The field on which to sort the results (see footnote 1). | name | | sort_direction | string | The direction in which to sort the results. Possible values are: asc or desc. | asc | | name | string | Full name of the Lead to search for. | none | | phone_number | string | Phone number of the Lead to search for. | none | | emails | string | Email of the Lead to search for. | none | | assignee_ids | number[] | The ids of Users that Leads are assigned to (see footnote 2). | none | | status_ids | number[] | An array of Lead status IDs (see footnote 3). | none | | customer_source_ids | number[] | An array of customer source IDs (see footnote 4). | none | | city | string | The city in which Leads must be located. | none | | state | string | The state or province in which Leads must be located. | none | | postal_code | string | The postal code in which Leads must be located. | none | | country | string | The two character country code where Leads must be located. | none | | tags | string[] | Filter Leads to those that match at least one of the tags specified. | none | | followed | number | 1: followed, 2: not followed | none | | age | number | The maximum age in seconds that each Lead must be. | none | | minimum_monetary_value | number | The minimum monetary value Leads must have. | none | | maximum_monetary_value | number | The maximum monetary value Leads must have. | none | | minimum_interaction_count | number | The minimum number of interactions Leads must have had. | none | | maximum_interaction_count | number | The maximum number of interactions Leads must have had. | none | | minimum_interaction_date | timestamp | The Unix timestamp of the earliest date of the last interaction. | none | | maximum_interaction_date | timestamp | The Unix timestamp of the latest date of the last interaction. | none | | minimum_created_date | timestamp | The Unix timestamp of the earliest date Leads are created. | none | | maximum_created_date | timestamp | The Unix timestamp of the latest date Leads are created. | none | | minimum_modified_date | timestamp | The Unix timestamp of the earliest date Leads are modified. | none | | maximum_modified_date | timestamp | The Unix timestamp of the latest date Leads are modified. | none | Foonotes: 1. Possible fields are: name, first_name, last_name, company_name, title, value, email, phone, date_modified, date_created, city, state, country, zip, inactive_days. - date_modified and date_created: sorting is from oldest to newest - inactive_days: sorting is from newest to oldest 2. To get User IDs, see `List Users` under `Acount and Users` folder. Enter -2 as an ID for no assignee. 3. To get lead status IDs, see `List Lead Statuses` under `Other Resources` folder. 4. To get customer source IDs, see `List Customer Sources` under `Other Resources` folder. Enter -2 as an ID for no customer source. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/2LeadsListLeadsSearchRequest' examples: List Leads (Search): value: maximum_interaction_date: 1515797000 minimum_interaction_date: 1515796000 page_size: 25 sort_by: name responses: '200': description: >- Search Leads by Customer Source IDs / Search Leads by Email / Search Leads by Custom Multi-Select Dropdown Set to Empty / Search Leads by Tags / Search Leads by Followed / Search Leads by Custom Multi-Select Dropdown / Search Leads by Empty Field / List Leads in groups of 200 / Search Leads by Status IDs / Search Leads by Assignee IDs / Search Leads by City / Search Leads by Phone Number / Search Leads by Status Change Date / Search Leads by State / Search Leads by Created Date / Leads Search / Search Leads by Monetary Value / Search Leads by Custom Date Field / Search Leads by Interaction Count / Search Leads by Country / Search Leads by Full Name / Search Leads by Modified Date / Search Leads by Postal Code / Search Leads by Interaction Date headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: keep-alive Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Fri, 12 Jan 2018 22:34:52 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: nginx/1.12.2 Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTAyNmI5MGY4OTg5MDQ2NDBkNWQ1ZGUxNDU4MmQyMWJmBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMUlONTNKQUU3bGczS2pmV24vUzE0S3I5S3YxQUJhUzFuelRTQm9NcGF2OTQ9BjsARg%3D%3D--b2a6d835c09ab10305dde74393f501d2e36bf8e3; domain=lvh.me; path=/; expires=Sat, 12-Jan-2019 22:34:52 GMT; HttpOnly Status: schema: type: string example: 200 OK Transfer-Encoding: schema: type: string example: chunked Vary: schema: type: string example: Accept-Encoding X-Frame-Options: schema: type: string example: SAMEORIGIN X-PW-TOTAL: schema: type: string example: '1' X-Rack-CORS: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 86218a15f1d98bc98cc8a215de11d472 X-Runtime: schema: type: string example: '0.688702' X-UA-Compatible: schema: type: string example: IE=Edge content: application/json: schema: $ref: '#/components/schemas/2LeadsListLeadsSearchResponse' examples: Leads Search: value: - tags: [] title: null address: null assignee_id: null company_name: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null customer_source_id: null date_created: 1490045162 date_modified: 1490045162 details: null email: category: work email: mycontact@noemail.com first_name: My id: 9150547 interaction_count: 0 last_name: Contact middle_name: null monetary_value: null name: My Contact phone_numbers: [] prefix: null socials: [] status: New status_id: 208231 suffix: null websites: [] - tags: [] title: null address: null assignee_id: null company_name: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null customer_source_id: null date_created: 1490045237 date_modified: 1490045237 details: null email: null first_name: My id: 9150552 interaction_count: 0 last_name: Contact middle_name: null monetary_value: null name: My Contact phone_numbers: - category: mobile number: 415-123-45678 prefix: null socials: [] status: New status_id: 208231 suffix: null websites: [] - tags: [] title: null address: null assignee_id: null company_name: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null customer_source_id: null date_created: 1490045279 date_modified: 1490045279 details: null email: null first_name: My id: 9150578 interaction_count: 0 last_name: Contact middle_name: null monetary_value: null name: My Contact phone_numbers: - category: mobile number: 415-123-45678 prefix: null socials: [] status: New status_id: 208231 suffix: null websites: [] - tags: [] title: null address: null assignee_id: null company_name: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null customer_source_id: null date_created: 1489528899 date_modified: 1489528899 details: null email: category: work email: mylead@noemail.com first_name: My id: 8982554 interaction_count: 0 last_name: Lead middle_name: null monetary_value: null name: My Lead phone_numbers: [] prefix: null socials: [] status: New status_id: 208231 suffix: null websites: [] - tags: [] title: null address: null assignee_id: null company_name: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null customer_source_id: null date_created: 1489531171 date_modified: 1489531171 details: null email: category: work email: mylead@gmail.test first_name: My id: 8982702 interaction_count: 0 last_name: Lead middle_name: null monetary_value: null name: My Lead phone_numbers: [] prefix: null socials: [] status: New status_id: 208231 suffix: null websites: [] - tags: [] title: null address: null assignee_id: null company_name: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null customer_source_id: null date_created: 1489791225 date_modified: 1489791225 details: null email: category: work email: mylead@noemail.com first_name: My id: 9094361 interaction_count: 0 last_name: Lead middle_name: null monetary_value: null name: My Lead phone_numbers: [] prefix: null socials: [] status: New status_id: 208231 suffix: null websites: [] - tags: [] title: null address: null assignee_id: null company_name: null custom_fields: - custom_field_definition_id: 100764 value: '123456789012345678901234567890' - custom_field_definition_id: 103481 value: '123456789012345678901234567890' customer_source_id: null date_created: 1489791283 date_modified: 1489791283 details: null email: category: work email: mylead@noemail.com first_name: My id: 9094364 interaction_count: 0 last_name: Lead middle_name: null monetary_value: null name: My Lead phone_numbers: [] prefix: null socials: [] status: New status_id: 208231 suffix: null websites: [] - tags: [] title: null address: null assignee_id: null company_name: null custom_fields: - custom_field_definition_id: 100764 value: >- |--------1---------2---------3---------4---------5---------6---------7---------8---------9---------|--------1---------2---------3---------4---------5---------6---------7---------8---------9--------- - custom_field_definition_id: 103481 value: '123456789012345678901234567890' customer_source_id: null date_created: 1489791417 date_modified: 1489791417 details: null email: category: work email: mylead@noemail.com first_name: My id: 9094371 interaction_count: 0 last_name: Lead middle_name: null monetary_value: null name: My Lead phone_numbers: [] prefix: null socials: [] status: New status_id: 208231 suffix: null websites: [] - tags: [] title: null address: null assignee_id: null company_name: null custom_fields: - custom_field_definition_id: 100764 value: >- |--------1---------2---------3---------4---------5---------6---------7---------8---------9---------|--------1---------2---------3---------4---------5---------6---------7---------8---------9---------|--------1---------2---------3---------4---------5----- - custom_field_definition_id: 103481 value: '123456789012345678901234567890' customer_source_id: null date_created: 1489791453 date_modified: 1489791453 details: null email: category: work email: mylead@noemail.com first_name: My id: 9094372 interaction_count: 0 last_name: Lead middle_name: null monetary_value: null name: My Lead phone_numbers: [] prefix: null socials: [] status: New status_id: 208231 suffix: null websites: [] - tags: [] title: null address: null assignee_id: null company_name: null custom_fields: - custom_field_definition_id: 100764 value: >- |--------1---------2---------3---------4---------5---------6---------7---------8---------9---------|--------1---------2---------3---------4---------5---------6---------7---------8---------9---------|--------1---------2---------3---------4---------5----- - custom_field_definition_id: 103481 value: >- |--------1---------2---------3---------4---------5---------6---------7---------8---------9---------|--------1---------2---------3---------4---------5---------6---------7---------8---------9---------|--------1---------2---------3---------4---------5---------6---------7---------8---------9--------- customer_source_id: null date_created: 1489791470 date_modified: 1489791470 details: null email: category: work email: mylead@noemail.com first_name: My id: 9094373 interaction_count: 0 last_name: Lead middle_name: null monetary_value: null name: My Lead phone_numbers: [] prefix: null socials: [] status: New status_id: 208231 suffix: null websites: [] - tags: [] title: null address: null assignee_id: null company_name: null custom_fields: - custom_field_definition_id: 100764 value: >- |--------1---------2---------3---------4---------5---------6---------7---------8---------9---------|--------1---------2---------3---------4---------5---------6---------7---------8---------9---------|--------1---------2---------3---------4---------5----- - custom_field_definition_id: 103481 value: >- |--------1---------2---------3---------4---------5---------6---------7---------8---------9---------|--------1---------2---------3---------4---------5---------6---------7---------8---------9---------|--------1---------2---------3---------4---------5---------6---------7---------8---------9---------|--------1---------2---------3---------4---------5---------6---------7---------8---------9---------|--------1---------2---------3---------4---------5---------6---------7---------8---------9--------- customer_source_id: null date_created: 1489791672 date_modified: 1489791672 details: null email: category: work email: mylead@noemail.com first_name: My id: 9094383 interaction_count: 0 last_name: Lead middle_name: null monetary_value: null name: My Lead phone_numbers: [] prefix: null socials: [] status: New status_id: 208231 suffix: null websites: [] - tags: [] title: null address: null assignee_id: null company_name: null custom_fields: - custom_field_definition_id: 100764 value: Text fields are 255 chars or less! - custom_field_definition_id: 103481 value: |- text text customer_source_id: null date_created: 1490112942 date_modified: 1490112942 details: null email: category: work email: mylead@noemail.com first_name: My id: 9174441 interaction_count: 0 last_name: Lead middle_name: null monetary_value: null name: My Lead phone_numbers: [] prefix: null socials: [] status: New status_id: 208231 suffix: null websites: [] - tags: [] title: null address: null assignee_id: null company_name: null custom_fields: - custom_field_definition_id: 100764 value: Text fields are 255 chars or less! - custom_field_definition_id: 103481 value: text /n text customer_source_id: null date_created: 1490112953 date_modified: 1490112953 details: null email: category: work email: mylead@noemail.com first_name: My id: 9174443 interaction_count: 0 last_name: Lead middle_name: null monetary_value: null name: My Lead phone_numbers: [] prefix: null socials: [] status: New status_id: 208231 suffix: null websites: [] - tags: - tag 1 - tag 2 title: Title address: city: San Francisco country: US postal_code: '94105' state: CA street: 301 Howard St Ste 600 assignee_id: 137658 company_name: Lead's Company custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null customer_source_id: 331241 date_created: 1489018784 date_modified: 1496692911 details: This is an update email: category: work email: address@workemail.com first_name: Test id: 8894157 interaction_count: 0 last_name: Lead middle_name: null monetary_value: 100 name: Test Lead phone_numbers: - category: mobile number: 415-999-4321 - category: work number: 415-555-1234 prefix: null socials: - category: facebook url: facebook.com/test_lead status: New status_id: 208231 suffix: null websites: - category: work url: www.workwebsite.com List Leads in groups of 200: value: - tags: - blah title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null customer_source_id: 4 date_created: 1515434872 date_last_contacted: 1515796263 date_modified: 1516743967 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 1 last_name: null middle_name: null monetary_unit: USD monetary_value: 2501 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 5 suffix: null websites: - category: work url: http://www.dundermifflin.com - tags: - sample title: Office Coordinator address: null assignee_id: null company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 4 date_created: 1515434872 date_last_contacted: null date_modified: 1515795399 details: >- A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity. Once your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works! email: category: work email: pam@dundermifflin.com first_name: Pam Beesly (sample) id: 5 interaction_count: 0 last_name: null middle_name: null monetary_unit: USD monetary_value: 5000 name: Pam Beesly (sample) phone_numbers: - category: work number: '5105553333' prefix: null socials: [] status: Unqualified status_id: 7 suffix: null websites: - category: work url: http://www.dundermifflin.com - tags: [] title: null address: city: San Francisco country: '' postal_code: '94114' state: CA street: 123 Abc Rd assignee_id: 2 company_name: null custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: null date_created: 1516671366 date_last_contacted: null date_modified: 1516671455 details: null email: null first_name: Test id: 12 interaction_count: 0 last_name: User middle_name: null monetary_unit: null monetary_value: null name: Test User phone_numbers: [] prefix: null socials: [] status: New status_id: 5 suffix: null websites: [] Search Leads by Assignee IDs: value: - tags: [] title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: [] customer_source_id: 4 date_created: 1515434872 date_last_contacted: null date_modified: 1515783705 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 0 last_name: null middle_name: null monetary_unit: null monetary_value: 2500 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: Unqualified status_id: 7 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Leads by City: value: - tags: - tag1 title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: [] customer_source_id: 4 date_created: 1515434872 date_last_contacted: null date_modified: 1515795800 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 0 last_name: null middle_name: null monetary_unit: USD monetary_value: 2500 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 5 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Leads by Country: value: - tags: - tag1 title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: [] customer_source_id: 4 date_created: 1515434872 date_last_contacted: null date_modified: 1515795800 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 0 last_name: null middle_name: null monetary_unit: USD monetary_value: 2500 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 5 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Leads by Created Date: value: - tags: - tag1 title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: [] customer_source_id: 4 date_created: 1515434872 date_last_contacted: 1515796263 date_modified: 1515796276 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 1 last_name: null middle_name: null monetary_unit: USD monetary_value: 2500 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 5 suffix: null websites: - category: work url: http://www.dundermifflin.com - tags: - sample title: Office Coordinator address: null assignee_id: null company_name: Dunder Mifflin, Inc. custom_fields: [] customer_source_id: 4 date_created: 1515434872 date_last_contacted: null date_modified: 1515795399 details: >- A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity. Once your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works! email: category: work email: pam@dundermifflin.com first_name: Pam Beesly (sample) id: 5 interaction_count: 0 last_name: null middle_name: null monetary_unit: USD monetary_value: 5000 name: Pam Beesly (sample) phone_numbers: - category: work number: '5105553333' prefix: null socials: [] status: Unqualified status_id: 7 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Leads by Custom Date Field: value: - tags: - tag1 title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: [] customer_source_id: 4 date_created: 1515434872 date_last_contacted: 1515796263 date_modified: 1515800180 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 1 last_name: null middle_name: null monetary_unit: USD monetary_value: 2500 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 5 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Leads by Custom Multi-Select Dropdown: value: - tags: - tag1 title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 customer_source_id: 4 date_created: 1515434872 date_last_contacted: 1515796263 date_modified: 1515800495 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 1 last_name: null middle_name: null monetary_unit: USD monetary_value: 2500 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 5 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Leads by Custom Multi-Select Dropdown Set to Empty: value: - tags: - sample title: Office Coordinator address: null assignee_id: null company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 6 value: null customer_source_id: 4 date_created: 1515434872 date_last_contacted: null date_modified: 1515795399 details: >- A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity. Once your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works! email: category: work email: pam@dundermifflin.com first_name: Pam Beesly (sample) id: 5 interaction_count: 0 last_name: null middle_name: null monetary_unit: USD monetary_value: 5000 name: Pam Beesly (sample) phone_numbers: - category: work number: '5105553333' prefix: null socials: [] status: Unqualified status_id: 7 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Leads by Customer Source IDs: value: - tags: [] title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: [] customer_source_id: 4 date_created: 1515434872 date_last_contacted: null date_modified: 1515786833 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 0 last_name: null middle_name: null monetary_unit: null monetary_value: 2500 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 5 suffix: null websites: - category: work url: http://www.dundermifflin.com - tags: - sample title: Office Coordinator address: null assignee_id: null company_name: Dunder Mifflin, Inc. custom_fields: [] customer_source_id: 4 date_created: 1515434872 date_last_contacted: null date_modified: 1515525131 details: >- A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity. Once your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works! email: category: work email: pam@dundermifflin.com first_name: Pam Beesly (sample) id: 5 interaction_count: 0 last_name: null middle_name: null monetary_unit: null monetary_value: 5000 name: Pam Beesly (sample) phone_numbers: - category: work number: '5105553333' prefix: null socials: [] status: Unqualified status_id: 7 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Leads by Email: value: - tags: - blah title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 customer_source_id: 4 date_created: 1515434872 date_last_contacted: 1515796263 date_modified: 1516214189 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 1 last_name: null middle_name: null monetary_unit: USD monetary_value: 2501 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 5 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Leads by Empty Field: value: - tags: - blah title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 customer_source_id: 4 date_created: 1515434872 date_last_contacted: 1515796263 date_modified: 1516214189 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 1 last_name: null middle_name: null monetary_unit: USD monetary_value: 2501 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 5 suffix: null websites: - category: work url: http://www.dundermifflin.com - tags: - sample title: Office Coordinator address: null assignee_id: null company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 6 value: null customer_source_id: 4 date_created: 1515434872 date_last_contacted: null date_modified: 1515795399 details: >- A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity. Once your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works! email: category: work email: pam@dundermifflin.com first_name: Pam Beesly (sample) id: 5 interaction_count: 0 last_name: null middle_name: null monetary_unit: USD monetary_value: 5000 name: Pam Beesly (sample) phone_numbers: - category: work number: '5105553333' prefix: null socials: [] status: Unqualified status_id: 7 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Leads by Followed: value: - tags: - tag1 title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: [] customer_source_id: 4 date_created: 1515434872 date_last_contacted: 1515796263 date_modified: 1515796276 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 1 last_name: null middle_name: null monetary_unit: USD monetary_value: 2500 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 5 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Leads by Full Name: value: - tags: - tag1 title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 customer_source_id: 4 date_created: 1515434872 date_last_contacted: 1515796263 date_modified: 1515800495 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 1 last_name: null middle_name: null monetary_unit: USD monetary_value: 2500 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 5 suffix: null websites: - category: work url: http://www.dundermifflin.com - tags: - sample title: Office Coordinator address: null assignee_id: null company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 6 value: null customer_source_id: 4 date_created: 1515434872 date_last_contacted: null date_modified: 1515795399 details: >- A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity. Once your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works! email: category: work email: pam@dundermifflin.com first_name: Pam Beesly (sample) id: 5 interaction_count: 0 last_name: null middle_name: null monetary_unit: USD monetary_value: 5000 name: Pam Beesly (sample) phone_numbers: - category: work number: '5105553333' prefix: null socials: [] status: Unqualified status_id: 7 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Leads by Interaction Count: value: - tags: - tag1 title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: [] customer_source_id: 4 date_created: 1515434872 date_last_contacted: 1515796263 date_modified: 1515796276 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 1 last_name: null middle_name: null monetary_unit: USD monetary_value: 2500 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 5 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Leads by Interaction Date: value: - tags: - tag1 title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: [] customer_source_id: 4 date_created: 1515434872 date_last_contacted: 1515796263 date_modified: 1515796276 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 1 last_name: null middle_name: null monetary_unit: USD monetary_value: 2500 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 5 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Leads by Modified Date: value: - tags: - tag1 title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: [] customer_source_id: 4 date_created: 1515434872 date_last_contacted: 1515796263 date_modified: 1515796276 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 1 last_name: null middle_name: null monetary_unit: USD monetary_value: 2500 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 5 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Leads by Monetary Value: value: - tags: [] title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: [] customer_source_id: 4 date_created: 1515434872 date_last_contacted: null date_modified: 1515795399 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 0 last_name: null middle_name: null monetary_unit: USD monetary_value: 2500 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 5 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Leads by Phone Number: value: - tags: - tag1 title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 customer_source_id: 4 date_created: 1515434872 date_last_contacted: 1515796263 date_modified: 1515800495 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 1 last_name: null middle_name: null monetary_unit: USD monetary_value: 2500 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 5 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Leads by Postal Code: value: - tags: - tag1 title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: [] customer_source_id: 4 date_created: 1515434872 date_last_contacted: null date_modified: 1515795800 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 0 last_name: null middle_name: null monetary_unit: USD monetary_value: 2500 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 5 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Leads by State: value: - tags: - tag1 title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: [] customer_source_id: 4 date_created: 1515434872 date_last_contacted: null date_modified: 1515795800 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 0 last_name: null middle_name: null monetary_unit: USD monetary_value: 2500 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 5 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Leads by Status Change Date: value: - tags: - tag1 title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: [] customer_source_id: 4 date_created: 1515434872 date_last_contacted: 1515796263 date_modified: 1515796276 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 1 last_name: null middle_name: null monetary_unit: USD monetary_value: 2500 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 5 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Leads by Status IDs: value: - tags: [] title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: [] customer_source_id: 4 date_created: 1515434872 date_last_contacted: null date_modified: 1515783705 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 0 last_name: null middle_name: null monetary_unit: null monetary_value: 2500 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: Unqualified status_id: 7 suffix: null websites: - category: work url: http://www.dundermifflin.com - tags: - sample title: Office Coordinator address: null assignee_id: null company_name: Dunder Mifflin, Inc. custom_fields: [] customer_source_id: 4 date_created: 1515434872 date_last_contacted: null date_modified: 1515525131 details: >- A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity. Once your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works! email: category: work email: pam@dundermifflin.com first_name: Pam Beesly (sample) id: 5 interaction_count: 0 last_name: null middle_name: null monetary_unit: null monetary_value: 5000 name: Pam Beesly (sample) phone_numbers: - category: work number: '5105553333' prefix: null socials: [] status: Unqualified status_id: 7 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Leads by Tags: value: - tags: - blah title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 customer_source_id: 4 date_created: 1515434872 date_last_contacted: 1515796263 date_modified: 1516214189 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 1 last_name: null middle_name: null monetary_unit: USD monetary_value: 2501 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 5 suffix: null websites: - category: work url: http://www.dundermifflin.com /leads/{example_lead_id}/activities: parameters: - name: example_lead_id in: path required: true schema: type: string post: tags: - 2. Leads summary: See a Lead's Activities operationId: 2Leads_getLeadActivities description: >- This request will show the Activity entries created for a specific Lead. For more details please see the notes at the [/activities endpoint](https://dev.prosperworks.com). parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/2LeadsGetLeadActivitiesRequest' examples: See a Lead's Activities: value: activity_types: - category: user id: 1 responses: '200': description: Lead Activities headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Mon, 05 Jun 2017 21:08:28 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJWE4ZTliNTk0ZGMxNWNiYzEwODNlY2VlN2Y1MjVmYTBiBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMWxoSUd0Qi9NUTlsWEtkZUdPa0ZwVER2cGIzL05vdHgybkNzaVlIc29BbTA9BjsARg%3D%3D--829e2135156aa3a2f9b149d54ba6e7d9760b6015; domain=prosperworks.com; path=/; expires=Tue, 05-Jun-2018 21:08:28 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 4c340df1-afb9-4427-9931-4172bea65104 X-Runtime: schema: type: string example: '0.214378' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/2LeadsGetLeadActivitiesResponse' examples: Lead Activities: value: - activity_date: 1522455323 date_created: 1522455329 date_modified: 1522455323 details: Phone call with Dave id: 68 new_value: null old_value: null parent: id: 1 type: lead type: category: user id: 1 user_id: 1 /customer_sources: get: tags: - 5. Opportunities summary: List Customer Sources operationId: 5Opportunities_listCustomerSources description: >- Customer Sources identify where a particular Lead or Opportunity came from. The Customer Sources API allows you to retrieve the list of Customer Sources associated with your Copper account. |Field|Details| |---|---| |id (number)|Unique* identifier for the customer source.| |name (string)| Label for the customer source definition| parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: Customer Sources / Customer Sources headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Thu, 08 Jun 2017 18:17:44 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJWQzMzExMjA0MjY2MGFjNTgwMjQ0MzNhNGJhZDcwMmExBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMS93bGhRUXRNVkZUeENRQjJDdVByUEkvMEx3c2FqZDVJSVBFc2NFOFowQUU9BjsARg%3D%3D--17929806d9ee75df558e2ff85c3fd102d6399da1; domain=prosperworks.com; path=/; expires=Fri, 08-Jun-2018 18:17:44 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 8e6d60ab-d4db-4d3c-86b0-f74d10aca5cd X-Runtime: schema: type: string example: '0.145985' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/5OpportunitiesListCustomerSourcesResponse' examples: Customer Sources: value: - id: 331240 name: Email - id: 331241 name: Cold Call - id: 331242 name: Advertising /lead_statuses: get: tags: - 2. Leads summary: List Lead Statuses operationId: 2Leads_listLeadStatuses description: >- Lead statuses are values that can be assigned to a Lead entity to indicate where they are in the qualification process. | Field | Description | | -------------------- | ------------------------------------------------------------------------------ | | id (number) | Unique identifier for the status | | name (string) | The name of the lead status | | order (number) | The position of the value in the list when displayed in the app | | is_default (boolean) | Indicates whether this value is selected as default when creating a new record | parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: Lead Statuses headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Thu, 08 Jun 2017 18:36:29 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJWQzMzExMjA0MjY2MGFjNTgwMjQ0MzNhNGJhZDcwMmExBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMS93bGhRUXRNVkZUeENRQjJDdVByUEkvMEx3c2FqZDVJSVBFc2NFOFowQUU9BjsARg%3D%3D--17929806d9ee75df558e2ff85c3fd102d6399da1; domain=prosperworks.com; path=/; expires=Fri, 08-Jun-2018 18:36:29 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: f1c39b72-c49b-4631-bd4a-8be0646090f7 X-Runtime: schema: type: string example: '0.123236' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/2LeadsListLeadStatusesResponse' examples: Lead Statuses: value: - id: 208231 is_default: true name: New order: 1 - id: 208232 is_default: false name: Open order: 2 - id: 208233 is_default: false name: Unqualified order: 3 - id: 208234 is_default: false name: Junk order: 4 /people/{example_person_id}: parameters: - name: example_person_id in: path required: true schema: type: string get: tags: - 3. People summary: Fetch a Person by ID operationId: 3People_getById description: Fetch a Person by ID parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: '' put: tags: - 3. People summary: Update a Person operationId: 3People_updatePersonById description: >- Updates are only applied to fields explicitly specified in the request body. For example, if an update request is made with an empty body, no updates will be made. To remove the value from a field, the request body must specify the target field value as 'null'. The field `company_id` is returned in the JSON response, However, if you would like to unrelate and relate a new `company_id`, use the related items API call to delete and then add a new `company_id` to the person record. For more info, see `Related Items` folder. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/3PeopleUpdatePersonByIdRequest' examples: Update a Person: value: details: This is an update responses: '200': description: Person Update headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Mon, 05 Jun 2017 21:57:43 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Tue, 05-Jun-2018 21:57:43 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 4ff28921-913c-4dd8-b6ba-0dc649d142ac X-Runtime: schema: type: string example: '0.423247' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/3PeopleUpdatePersonByIdResponse' examples: Person Update: value: tags: [] title: null address: city: '' country: '' postal_code: '' state: '' street: '' assignee_id: 137658 company_id: null company_name: null contact_type_id: 451490 custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1489018908 date_modified: 1496699863 details: This is an update emails: [] first_name: Person id: 26443553 interaction_count: 0 last_name: Default middle_name: null name: Person Default phone_numbers: [] prefix: null socials: [] suffix: null websites: [] delete: tags: - 3. People summary: Delete a Person operationId: 3People_removePerson description: This request permanently removes a Person from your Copper account. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: text/plain: examples: Delete a Person: value: '' schema: description: >- WARNING: Missing schema in media type object. Missing schema has been filled with this AnyType schema. responses: '200': description: Delete Person headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Mon, 05 Jun 2017 22:00:17 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Tue, 05-Jun-2018 22:00:17 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: ff7ea1c8-8eb5-47df-b368-f0623bd70bb3 X-Runtime: schema: type: string example: '0.204549' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/3PeopleRemovePersonResponse' examples: Delete Person: value: id: 26443553 is_deleted: true /people/fetch_by_email: post: tags: - 3. People summary: Fetch a Person by Email operationId: 3People_getByEmail description: >- Email address is a unique key for People records in Copper. You can fetch a Person by it's email address using this operation. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/3PeopleGetByEmailRequest' examples: Fetch a Person by Email: value: email: mycontact_123@noemail.com responses: '200': description: Fetch by Emails headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Mon, 05 Jun 2017 21:40:55 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Tue, 05-Jun-2018 21:40:55 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: e8cf3cb4-1f03-4152-9f29-4dd8526fd4f2 X-Runtime: schema: type: string example: '0.141087' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/3PeopleGetByEmailResponse' examples: Fetch by Emails: value: tags: [] title: null address: null assignee_id: null company_id: null company_name: null contact_type_id: 451492 custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1490045413 date_modified: 1490045413 details: null emails: - category: work email: mycontact_123@noemail.com first_name: My id: 27140442 interaction_count: 0 last_name: Contact middle_name: null name: My Contact phone_numbers: - category: mobile number: 415-123-45678 prefix: null socials: [] suffix: null websites: [] /people: post: tags: - 3. People summary: Create a New Person operationId: 3People_createNewPerson description: Create a New Person parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/3PeopleCreateNewPersonRequest' examples: Create a New Person: value: emails: - category: work email: mycontact_1233@noemail.com name: My Contact phone_numbers: - category: mobile number: 415-123-45678 responses: '200': description: Create New Person headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Mon, 20 Mar 2017 21:30:51 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTcxYTBiMzc5NThlOWEzZGY1YWVkNzFhYmQxZDNhNGI2BjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMXI5cTh0YVUzczhDcUdTN1JqM0ozT0cwN2JFbzRUTXBZd3ZzcXVtejhOd0E9BjsARg%3D%3D--601fa0935bd57c2d71757369050a51811ed4f3d0; domain=prosperworks.com; path=/; expires=Tue, 20-Mar-2018 21:30:51 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 0dc08ba1-bd0e-48d1-b90e-3f3fd5fc3877 X-Runtime: schema: type: string example: '0.389312' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/3PeopleCreateNewPersonResponse' examples: Create New Person: value: tags: [] title: null address: null assignee_id: null company_id: null company_name: null contact_type_id: 451492 custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1490045450 date_modified: 1490045450 details: null emails: - category: work email: mycontact_1233@noemail.com first_name: My id: 27140448 last_name: Contact middle_name: null name: My Contact phone_numbers: - category: mobile number: 415-123-45678 prefix: null socials: [] suffix: null websites: [] /people/search: post: tags: - 3. People summary: List People (Search) operationId: 3People_listPeopleSearch description: >- The /search endpoint provides the ability to list people and sort the results by certain parameters. When multiple ciriteria are provided records meeting ALL criteria will be returned (the filtering criteria have an 'AND' relationship). To see examples of search request using the various parameters, click on the `People Search` dropdown on the right. Certain fields can be filtered by an empty value, i.e., filter records where the field is not specified. For Leads, these fields are: city, state, postal_code, tags, custom dropdown, custom multi-select fields. Some fields (e.g. assignee_ids) can also filter for an empty value by specifying -2 as the ID. To change the number of records returned, change the "page_size" parameter. E.g., specify 200 for a page size of 200 records. | Field | Type | Details | Default | | ------------------------- | --------- | ------------------------------------------------------------------------------ | ---------- | | page_number | number | The page number (starting with 1) that you would like to view. | 1 | | page_size | number | The number of entries included in a page of results | 20 | | sort_by | string | The field on which to sort the results (see footnote 1). | first_name | | sort_direction | string | The direction in which to sort the results. Possible values are: asc or desc. | asc | | name | string | Full name of the People to search for. | none | | phone_number | string | Phone number of the People to search for. | none | | emails | string[] | Emails of the People to search for. | none | | contact_type_ids | number[] | The contact type Ids to search for (see footnote 2). | none | | assignee_ids | number[] | The ids of Users that People must be owned by, or -2 for People with no owner. | none | | company_ids | number[] | The ids of Companies that People belong to, or -2 for People with no company. | none | | opportunity_ids | number[] | An array of Opportunity IDs (see footnote 3). | none | | city | string | The city in which People must be located. | none | | state | string | The state or province in which People must be located. | none | | postal_code | string | The postal code in which People must be located. | none | | country | string | The two character country code where People must be located. | none | | tags | string[] | Filter Leads to those that match at least one of the tags specified. | none | | followed | number | 1: followed, 2: not followed | none | | age | number | The maximum age in seconds that People must be. | none | | minimum_interaction_count | number | The minimum number of interactions People must have had. | none | | maximum_interaction_count | number | The maximum number of interactions People must have had. | none | | minimum_interaction_date | timestamp | The Unix timestamp of the earliest date of the last interaction. | none | | maximum_interaction_date | timestamp | The Unix timestamp of the latest date of the last interaction. | none | | minimum_created_date | timestamp | The Unix timestamp of the earliest date People are created. | none | | maximum_created_date | timestamp | The Unix timestamp of the latest date People are created. | none | Footnote: 1. Possible fields are: name, first_name, last_name, title, email, phone, date_modified, date_created, city, state, country, zip. 2. See `List Contact Types` under Other Resources folder. 3. See `List Opportunities (Search)` under 5. Opportunities folder. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/3PeopleListPeopleSearchRequest' examples: List People (Search): value: page_size: 25 phone_number: '4153554776' sort_by: name responses: '200': description: >- Search People by Contact Type / List People in Groups of 200 / Search People by Followed / Search People by Custom Date Field / Search People by Full Name / Search People by Assignee Id / Search People by Company Id / Search People by Custom Multi-Select Dropdown Set to Empty / Search People by Postal Code / Search People by Country / Search People by City / Search People by Custom Multi-Select Dropdown / Search People by Tags / Search People by State / People Search / Search People by Interaction Count / Search People by Opportunity Ids / Search People by Date Added / Search People by Last Interaction Date / Search People by Phone Number headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: keep-alive Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Thu, 18 Jan 2018 01:52:19 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: nginx/1.12.2 Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTAyNmI5MGY4OTg5MDQ2NDBkNWQ1ZGUxNDU4MmQyMWJmBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMUlONTNKQUU3bGczS2pmV24vUzE0S3I5S3YxQUJhUzFuelRTQm9NcGF2OTQ9BjsARg%3D%3D--b2a6d835c09ab10305dde74393f501d2e36bf8e3; domain=lvh.me; path=/; expires=Fri, 18-Jan-2019 01:52:19 GMT; HttpOnly Status: schema: type: string example: 200 OK Transfer-Encoding: schema: type: string example: chunked Vary: schema: type: string example: Accept-Encoding X-Frame-Options: schema: type: string example: SAMEORIGIN X-PW-TOTAL: schema: type: string example: '2' X-Rack-CORS: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 1abebc87060f8362e6055a85e4a6fb81 X-Runtime: schema: type: string example: '1.079136' X-UA-Compatible: schema: type: string example: IE=Edge content: application/json: schema: $ref: '#/components/schemas/3PeopleListPeopleSearchResponse' examples: List People in Groups of 200: value: - tags: [] title: Customer Support address: city: San Francisco country: '' postal_code: '94105' state: CA street: 221 Main Street Suite 1350 assignee_id: 2 company_id: 2 company_name: ProsperWorks contact_type_id: 5 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434863 date_last_contacted: null date_lead_created: null date_modified: 1516308658 details: This is an update emails: - category: work email: jackjames@prosperworks.com first_name: Jack id: 4 interaction_count: 0 last_name: James leads_converted_from: [] middle_name: null name: Jack James phone_numbers: - category: work number: '4153554776' prefix: null socials: - category: linkedin url: www.linkedin.com/pub/jack-james/54/172/b47 suffix: null websites: - category: work url: www.prosperworks.com - tags: [] title: CEO address: city: Philadelphia country: '' postal_code: '19135' state: PA street: 543 Washington Ave assignee_id: null company_id: 4 company_name: Sabre Inc (sample) contact_type_id: 5 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434865 date_last_contacted: null date_lead_created: null date_modified: 1515525462 details: null emails: - category: work email: jo@sabreinc.com first_name: Jo id: 6 interaction_count: 0 last_name: Bennett leads_converted_from: [] middle_name: null name: Jo Bennett, (sample) phone_numbers: [] prefix: null socials: [] suffix: (sample) websites: [] - tags: [] title: CEO address: city: San Francisco country: '' postal_code: '94105' state: CA street: 221 Main Street Suite 1350 assignee_id: null company_id: 2 company_name: ProsperWorks contact_type_id: 8 custom_fields: - custom_field_definition_id: 12 value: - 9 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434862 date_last_contacted: null date_lead_created: null date_modified: 1516313029 details: null emails: - category: work email: jonlee@prosperworks.com first_name: Jon id: 3 interaction_count: 0 last_name: Lee leads_converted_from: [] middle_name: null name: Jon Lee phone_numbers: - category: work number: '4153554776' prefix: null socials: - category: linkedin url: https://www.linkedin.com/in/jonlee168 suffix: null websites: - category: work url: www.prosperworks.com - tags: [] title: Regional Manager address: city: Scranton country: '' postal_code: '18501' state: PA street: 213 West Main Street assignee_id: null company_id: 3 company_name: Dunder Mifflin (sample) contact_type_id: 5 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434864 date_last_contacted: null date_lead_created: null date_modified: 1516310945 details: null emails: - category: work email: michael@dundermifflin.com first_name: Michael id: 5 interaction_count: 0 last_name: Scott leads_converted_from: [] middle_name: null name: Michael Scott, (sample) phone_numbers: - category: work number: '4152225466' prefix: null socials: [] suffix: (sample) websites: - category: work url: http://www.dundermifflin.com/index.shtml - tags: - tag1 title: Business Development address: city: Vancouver country: CA postal_code: A1A1A1 state: BC street: 221 Main Street Suite 1350 assignee_id: null company_id: 2 company_name: ProsperWorks contact_type_id: 8 custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1516262400 date_last_contacted: 1516313330 date_lead_created: null date_modified: 1516313340 details: null emails: - category: work email: taylor@prosperworks.com first_name: Taylor id: 7 interaction_count: 2 last_name: Lowe leads_converted_from: [] middle_name: null name: Jim Halpert phone_numbers: - category: work number: '4158546956' prefix: null socials: - category: linkedin url: https://www.linkedin.com/in/jimhalpert suffix: null websites: - category: work url: www.prosperworks.com People Search: value: - tags: [] title: null address: null assignee_id: null company_id: null company_name: null contact_type_id: 451492 custom_fields: - custom_field_definition_id: 100764 value: Text fields are 255 chars or less! - custom_field_definition_id: 103481 value: Text area fields can have long text content date_created: 1490044880 date_modified: 1490044880 details: null emails: [] first_name: My id: 27140338 interaction_count: 0 last_name: Contact middle_name: null name: My Contact phone_numbers: [] prefix: null socials: [] suffix: null websites: [] - tags: [] title: null address: null assignee_id: null company_id: 13349319 company_name: Noemail contact_type_id: 451492 custom_fields: - custom_field_definition_id: 100764 value: Text fields are 255 chars or less! - custom_field_definition_id: 103481 value: Text area fields can have long text content date_created: 1490045010 date_modified: 1496694271 details: null emails: - category: work email: mylead@noemail.com first_name: My id: 27140359 interaction_count: 0 last_name: Contact middle_name: null name: My Contact phone_numbers: [] prefix: null socials: [] suffix: null websites: [] - tags: [] title: null address: null assignee_id: null company_id: null company_name: null contact_type_id: 451492 custom_fields: - custom_field_definition_id: 100764 value: Text fields are 255 chars or less! - custom_field_definition_id: 103481 value: Text area fields can have long text content date_created: 1490045046 date_modified: 1490045046 details: null emails: - category: work email: mylead_1234@noemail.com first_name: My id: 27140372 interaction_count: 0 last_name: Contact middle_name: null name: My Contact phone_numbers: - category: mobile number: 415-123-45678 prefix: null socials: [] suffix: null websites: [] - tags: [] title: null address: null assignee_id: null company_id: null company_name: null contact_type_id: 451492 custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1490045377 date_modified: 1490045377 details: null emails: - category: work email: mycontact_1234@noemail.com first_name: My id: 27140432 interaction_count: 0 last_name: Contact middle_name: null name: My Contact phone_numbers: - category: mobile number: 415-123-45678 prefix: null socials: [] suffix: null websites: [] - tags: [] title: null address: null assignee_id: null company_id: null company_name: null contact_type_id: 451492 custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1490045413 date_modified: 1490045413 details: null emails: - category: work email: mycontact_123@noemail.com first_name: My id: 27140442 interaction_count: 0 last_name: Contact middle_name: null name: My Contact phone_numbers: - category: mobile number: 415-123-45678 prefix: null socials: [] suffix: null websites: [] - tags: [] title: null address: null assignee_id: null company_id: null company_name: null contact_type_id: 451492 custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1490045450 date_modified: 1490045450 details: null emails: - category: work email: mycontact_1233@noemail.com first_name: My id: 27140448 interaction_count: 0 last_name: Contact middle_name: null name: My Contact phone_numbers: - category: mobile number: 415-123-45678 prefix: null socials: [] suffix: null websites: [] - tags: [] title: null address: city: '' country: '' postal_code: '' state: '' street: '' assignee_id: 137658 company_id: null company_name: null contact_type_id: 451490 custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1489018908 date_modified: 1490115067 details: null emails: [] first_name: Person id: 26443553 interaction_count: 0 last_name: Default middle_name: null name: Person Default phone_numbers: [] prefix: null socials: [] suffix: null websites: [] Search People by Assignee Id: value: - tags: [] title: Customer Support address: city: San Francisco country: '' postal_code: '94105' state: CA street: 221 Main Street Suite 1350 assignee_id: 2 company_id: 2 company_name: ProsperWorks contact_type_id: 8 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434863 date_last_contacted: null date_lead_created: null date_modified: 1516299085 details: This is an update emails: - category: work email: jackjames@prosperworks.com first_name: Jack id: 4 interaction_count: 0 last_name: James leads_converted_from: [] middle_name: null name: Jack James phone_numbers: - category: work number: '4153554776' prefix: null socials: - category: linkedin url: www.linkedin.com/pub/jack-james/54/172/b47 suffix: null websites: - category: work url: www.prosperworks.com Search People by City: value: - tags: [] title: Regional Manager address: city: Scranton country: '' postal_code: '18501' state: PA street: 213 West Main Street assignee_id: null company_id: 3 company_name: Dunder Mifflin (sample) contact_type_id: 5 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434864 date_last_contacted: null date_lead_created: null date_modified: 1516310945 details: null emails: - category: work email: michael@dundermifflin.com first_name: Michael id: 5 interaction_count: 0 last_name: Scott leads_converted_from: [] middle_name: null name: Michael Scott, (sample) phone_numbers: - category: work number: '4152225466' prefix: null socials: [] suffix: (sample) websites: - category: work url: http://www.dundermifflin.com/index.shtml Search People by Company Id: value: - tags: [] title: Customer Support address: city: San Francisco country: '' postal_code: '94105' state: CA street: 221 Main Street Suite 1350 assignee_id: 2 company_id: 2 company_name: ProsperWorks contact_type_id: 8 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434863 date_last_contacted: null date_lead_created: null date_modified: 1516299085 details: This is an update emails: - category: work email: jackjames@prosperworks.com first_name: Jack id: 4 interaction_count: 0 last_name: James leads_converted_from: [] middle_name: null name: Jack James phone_numbers: - category: work number: '4153554776' prefix: null socials: - category: linkedin url: www.linkedin.com/pub/jack-james/54/172/b47 suffix: null websites: - category: work url: www.prosperworks.com - tags: [] title: CEO address: city: San Francisco country: '' postal_code: '94105' state: CA street: 221 Main Street Suite 1350 assignee_id: null company_id: 2 company_name: ProsperWorks contact_type_id: 8 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434862 date_last_contacted: null date_lead_created: null date_modified: 1515434877 details: null emails: - category: work email: jonlee@prosperworks.com first_name: Jon id: 3 interaction_count: 0 last_name: Lee leads_converted_from: [] middle_name: null name: Jon Lee phone_numbers: - category: work number: '4153554776' prefix: null socials: - category: linkedin url: https://www.linkedin.com/in/jonlee168 suffix: null websites: - category: work url: www.prosperworks.com - tags: [] title: Business Development address: city: San Francisco country: '' postal_code: '94105' state: CA street: 221 Main Street Suite 1350 assignee_id: null company_id: 2 company_name: ProsperWorks contact_type_id: 8 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1516262400 date_last_contacted: null date_lead_created: null date_modified: 1516299712 details: null emails: - category: work email: taylor@prosperworks.com first_name: Taylor id: 7 interaction_count: 0 last_name: Lowe leads_converted_from: [] middle_name: null name: Jim Halpert phone_numbers: - category: work number: '4158546956' prefix: null socials: - category: linkedin url: https://www.linkedin.com/in/jimhalpert suffix: null websites: - category: work url: www.prosperworks.com Search People by Contact Type: value: - tags: [] title: CEO address: city: Philadelphia country: '' postal_code: '19135' state: PA street: 543 Washington Ave assignee_id: null company_id: 4 company_name: Sabre Inc (sample) contact_type_id: 5 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434865 date_last_contacted: null date_lead_created: null date_modified: 1515525462 details: null emails: - category: work email: jo@sabreinc.com first_name: Jo id: 6 interaction_count: 0 last_name: Bennett leads_converted_from: [] middle_name: null name: Jo Bennett, (sample) phone_numbers: [] prefix: null socials: [] suffix: (sample) websites: [] - tags: [] title: Regional Manager address: city: Scranton country: '' postal_code: '18501' state: PA street: 213 West Main Street assignee_id: null company_id: 3 company_name: Dunder Mifflin (sample) contact_type_id: 5 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434864 date_last_contacted: null date_lead_created: null date_modified: 1515434877 details: null emails: - category: work email: michael@dundermifflin.com first_name: Michael id: 5 interaction_count: 0 last_name: Scott leads_converted_from: [] middle_name: null name: Michael Scott, (sample) phone_numbers: - category: work number: '4152225466' prefix: null socials: [] suffix: (sample) websites: - category: work url: http://www.dundermifflin.com/index.shtml Search People by Country: value: - tags: [] title: Business Development address: city: Vancouver country: CA postal_code: A1A1A1 state: BC street: 221 Main Street Suite 1350 assignee_id: null company_id: 2 company_name: ProsperWorks contact_type_id: 8 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1516262400 date_last_contacted: null date_lead_created: null date_modified: 1516311811 details: null emails: - category: work email: taylor@prosperworks.com first_name: Taylor id: 7 interaction_count: 0 last_name: Lowe leads_converted_from: [] middle_name: null name: Jim Halpert phone_numbers: - category: work number: '4158546956' prefix: null socials: - category: linkedin url: https://www.linkedin.com/in/jimhalpert suffix: null websites: - category: work url: www.prosperworks.com Search People by Custom Date Field: value: - tags: - tag1 title: Business Development address: city: Vancouver country: CA postal_code: A1A1A1 state: BC street: 221 Main Street Suite 1350 assignee_id: null company_id: 2 company_name: ProsperWorks contact_type_id: 8 custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1516262400 date_last_contacted: null date_lead_created: null date_modified: 1516312656 details: null emails: - category: work email: taylor@prosperworks.com first_name: Taylor id: 7 interaction_count: 0 last_name: Lowe leads_converted_from: [] middle_name: null name: Jim Halpert phone_numbers: - category: work number: '4158546956' prefix: null socials: - category: linkedin url: https://www.linkedin.com/in/jimhalpert suffix: null websites: - category: work url: www.prosperworks.com Search People by Custom Multi-Select Dropdown: value: - tags: - tag1 title: Business Development address: city: Vancouver country: CA postal_code: A1A1A1 state: BC street: 221 Main Street Suite 1350 assignee_id: null company_id: 2 company_name: ProsperWorks contact_type_id: 8 custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1516262400 date_last_contacted: null date_lead_created: null date_modified: 1516312771 details: null emails: - category: work email: taylor@prosperworks.com first_name: Taylor id: 7 interaction_count: 0 last_name: Lowe leads_converted_from: [] middle_name: null name: Jim Halpert phone_numbers: - category: work number: '4158546956' prefix: null socials: - category: linkedin url: https://www.linkedin.com/in/jimhalpert suffix: null websites: - category: work url: www.prosperworks.com Search People by Custom Multi-Select Dropdown Set to Empty: value: - tags: [] title: Customer Support address: city: San Francisco country: '' postal_code: '94105' state: CA street: 221 Main Street Suite 1350 assignee_id: 2 company_id: 2 company_name: ProsperWorks contact_type_id: 5 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434863 date_last_contacted: null date_lead_created: null date_modified: 1516308658 details: This is an update emails: - category: work email: jackjames@prosperworks.com first_name: Jack id: 4 interaction_count: 0 last_name: James leads_converted_from: [] middle_name: null name: Jack James phone_numbers: - category: work number: '4153554776' prefix: null socials: - category: linkedin url: www.linkedin.com/pub/jack-james/54/172/b47 suffix: null websites: - category: work url: www.prosperworks.com - tags: [] title: CEO address: city: Philadelphia country: '' postal_code: '19135' state: PA street: 543 Washington Ave assignee_id: null company_id: 4 company_name: Sabre Inc (sample) contact_type_id: 5 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434865 date_last_contacted: null date_lead_created: null date_modified: 1515525462 details: null emails: - category: work email: jo@sabreinc.com first_name: Jo id: 6 interaction_count: 0 last_name: Bennett leads_converted_from: [] middle_name: null name: Jo Bennett, (sample) phone_numbers: [] prefix: null socials: [] suffix: (sample) websites: [] - tags: [] title: Regional Manager address: city: Scranton country: '' postal_code: '18501' state: PA street: 213 West Main Street assignee_id: null company_id: 3 company_name: Dunder Mifflin (sample) contact_type_id: 5 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434864 date_last_contacted: null date_lead_created: null date_modified: 1516310945 details: null emails: - category: work email: michael@dundermifflin.com first_name: Michael id: 5 interaction_count: 0 last_name: Scott leads_converted_from: [] middle_name: null name: Michael Scott, (sample) phone_numbers: - category: work number: '4152225466' prefix: null socials: [] suffix: (sample) websites: - category: work url: http://www.dundermifflin.com/index.shtml Search People by Date Added: value: - tags: [] title: Business Development address: city: San Francisco country: '' postal_code: '94105' state: CA street: 221 Main Street Suite 1350 assignee_id: null company_id: 2 company_name: ProsperWorks contact_type_id: 8 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1516262400 date_last_contacted: null date_lead_created: null date_modified: 1516299712 details: null emails: - category: work email: taylor@prosperworks.com first_name: Taylor id: 7 interaction_count: 0 last_name: Lowe leads_converted_from: [] middle_name: null name: Jim Halpert phone_numbers: - category: work number: '4158546956' prefix: null socials: - category: linkedin url: https://www.linkedin.com/in/jimhalpert suffix: null websites: - category: work url: www.prosperworks.com Search People by Followed: value: - tags: [] title: Customer Support address: city: San Francisco country: '' postal_code: '94105' state: CA street: 221 Main Street Suite 1350 assignee_id: 2 company_id: 2 company_name: ProsperWorks contact_type_id: 5 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434863 date_last_contacted: null date_lead_created: null date_modified: 1516308658 details: This is an update emails: - category: work email: jackjames@prosperworks.com first_name: Jack id: 4 interaction_count: 0 last_name: James leads_converted_from: [] middle_name: null name: Jack James phone_numbers: - category: work number: '4153554776' prefix: null socials: - category: linkedin url: www.linkedin.com/pub/jack-james/54/172/b47 suffix: null websites: - category: work url: www.prosperworks.com Search People by Full Name: value: - tags: [] title: Customer Support address: city: San Francisco country: '' postal_code: '94105' state: CA street: 221 Main Street Suite 1350 assignee_id: null company_id: 2 company_name: ProsperWorks contact_type_id: 8 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434863 date_last_contacted: null date_lead_created: null date_modified: 1516240218 details: This is an update emails: - category: work email: jackjames@prosperworks.com first_name: Jack id: 4 interaction_count: 0 last_name: James leads_converted_from: [] middle_name: null name: Jack James phone_numbers: - category: work number: '4153554776' prefix: null socials: - category: linkedin url: www.linkedin.com/pub/jack-james/54/172/b47 suffix: null websites: - category: work url: www.prosperworks.com Search People by Interaction Count: value: - tags: - tag1 title: Business Development address: city: Vancouver country: CA postal_code: A1A1A1 state: BC street: 221 Main Street Suite 1350 assignee_id: null company_id: 2 company_name: ProsperWorks contact_type_id: 8 custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1516262400 date_last_contacted: 1516313330 date_lead_created: null date_modified: 1516313340 details: null emails: - category: work email: taylor@prosperworks.com first_name: Taylor id: 7 interaction_count: 2 last_name: Lowe leads_converted_from: [] middle_name: null name: Jim Halpert phone_numbers: - category: work number: '4158546956' prefix: null socials: - category: linkedin url: https://www.linkedin.com/in/jimhalpert suffix: null websites: - category: work url: www.prosperworks.com Search People by Last Interaction Date: value: - tags: - tag1 title: Business Development address: city: Vancouver country: CA postal_code: A1A1A1 state: BC street: 221 Main Street Suite 1350 assignee_id: null company_id: 2 company_name: ProsperWorks contact_type_id: 8 custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1516262400 date_last_contacted: 1516313330 date_lead_created: null date_modified: 1516313340 details: null emails: - category: work email: taylor@prosperworks.com first_name: Taylor id: 7 interaction_count: 2 last_name: Lowe leads_converted_from: [] middle_name: null name: Jim Halpert phone_numbers: - category: work number: '4158546956' prefix: null socials: - category: linkedin url: https://www.linkedin.com/in/jimhalpert suffix: null websites: - category: work url: www.prosperworks.com Search People by Opportunity Ids: value: - tags: [] title: Regional Manager address: city: Scranton country: '' postal_code: '18501' state: PA street: 213 West Main Street assignee_id: null company_id: 3 company_name: Dunder Mifflin (sample) contact_type_id: 5 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434864 date_last_contacted: null date_lead_created: null date_modified: 1516310945 details: null emails: - category: work email: michael@dundermifflin.com first_name: Michael id: 5 interaction_count: 0 last_name: Scott leads_converted_from: [] middle_name: null name: Michael Scott, (sample) phone_numbers: - category: work number: '4152225466' prefix: null socials: [] suffix: (sample) websites: - category: work url: http://www.dundermifflin.com/index.shtml Search People by Phone Number: value: - tags: [] title: Customer Support address: city: San Francisco country: '' postal_code: '94105' state: CA street: 221 Main Street Suite 1350 assignee_id: null company_id: 2 company_name: ProsperWorks contact_type_id: 8 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434863 date_last_contacted: null date_lead_created: null date_modified: 1516240218 details: This is an update emails: - category: work email: jackjames@prosperworks.com first_name: Jack id: 4 interaction_count: 0 last_name: James leads_converted_from: [] middle_name: null name: Jack James phone_numbers: - category: work number: '4153554776' prefix: null socials: - category: linkedin url: www.linkedin.com/pub/jack-james/54/172/b47 suffix: null websites: - category: work url: www.prosperworks.com - tags: [] title: CEO address: city: San Francisco country: '' postal_code: '94105' state: CA street: 221 Main Street Suite 1350 assignee_id: null company_id: 2 company_name: ProsperWorks contact_type_id: 8 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434862 date_last_contacted: null date_lead_created: null date_modified: 1515434877 details: null emails: - category: work email: jonlee@prosperworks.com first_name: Jon id: 3 interaction_count: 0 last_name: Lee leads_converted_from: [] middle_name: null name: Jon Lee phone_numbers: - category: work number: '4153554776' prefix: null socials: - category: linkedin url: https://www.linkedin.com/in/jonlee168 suffix: null websites: - category: work url: www.prosperworks.com Search People by Postal Code: value: - tags: [] title: Business Development address: city: Vancouver country: CA postal_code: A1A1A1 state: BC street: 221 Main Street Suite 1350 assignee_id: null company_id: 2 company_name: ProsperWorks contact_type_id: 8 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1516262400 date_last_contacted: null date_lead_created: null date_modified: 1516311811 details: null emails: - category: work email: taylor@prosperworks.com first_name: Taylor id: 7 interaction_count: 0 last_name: Lowe leads_converted_from: [] middle_name: null name: Jim Halpert phone_numbers: - category: work number: '4158546956' prefix: null socials: - category: linkedin url: https://www.linkedin.com/in/jimhalpert suffix: null websites: - category: work url: www.prosperworks.com Search People by State: value: - tags: [] title: CEO address: city: Philadelphia country: '' postal_code: '19135' state: PA street: 543 Washington Ave assignee_id: null company_id: 4 company_name: Sabre Inc (sample) contact_type_id: 5 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434865 date_last_contacted: null date_lead_created: null date_modified: 1515525462 details: null emails: - category: work email: jo@sabreinc.com first_name: Jo id: 6 interaction_count: 0 last_name: Bennett leads_converted_from: [] middle_name: null name: Jo Bennett, (sample) phone_numbers: [] prefix: null socials: [] suffix: (sample) websites: [] - tags: [] title: Regional Manager address: city: Scranton country: '' postal_code: '18501' state: PA street: 213 West Main Street assignee_id: null company_id: 3 company_name: Dunder Mifflin (sample) contact_type_id: 5 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434864 date_last_contacted: null date_lead_created: null date_modified: 1516310945 details: null emails: - category: work email: michael@dundermifflin.com first_name: Michael id: 5 interaction_count: 0 last_name: Scott leads_converted_from: [] middle_name: null name: Michael Scott, (sample) phone_numbers: - category: work number: '4152225466' prefix: null socials: [] suffix: (sample) websites: - category: work url: http://www.dundermifflin.com/index.shtml Search People by Tags: value: - tags: - tag1 title: Business Development address: city: Vancouver country: CA postal_code: A1A1A1 state: BC street: 221 Main Street Suite 1350 assignee_id: null company_id: 2 company_name: ProsperWorks contact_type_id: 8 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1516262400 date_last_contacted: null date_lead_created: null date_modified: 1516312015 details: null emails: - category: work email: taylor@prosperworks.com first_name: Taylor id: 7 interaction_count: 0 last_name: Lowe leads_converted_from: [] middle_name: null name: Jim Halpert phone_numbers: - category: work number: '4158546956' prefix: null socials: - category: linkedin url: https://www.linkedin.com/in/jimhalpert suffix: null websites: - category: work url: www.prosperworks.com /people/{example_person_id}/activities: parameters: - name: example_person_id in: path required: true schema: type: string post: tags: - 3. People summary: See a Person's Activities operationId: 3People_getPersonActivities description: >- This request will show the Activity entries created for a specific Person. For more details, please see the notes in the [Activities](https://developer.copper.com/?version=latest#2c9a03e2-bb9f-431b-8d22-3ff741d8dee3) section. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/3PeopleGetPersonActivitiesRequest' examples: See a Person's Activities: value: activity_types: - category: user id: 1 responses: '200': description: Person Activities headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Mon, 05 Jun 2017 23:00:03 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Tue, 05-Jun-2018 23:00:03 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 6a5da791-9ec8-4490-8cc5-974d8cbc81a3 X-Runtime: schema: type: string example: '0.223156' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/3PeopleGetPersonActivitiesResponse' examples: Person Activities: value: - activity_date: 1522694372 date_created: 1522694392 date_modified: 1522694372 details: Call with Rob id: 70 new_value: null old_value: null parent: id: 2 type: person type: category: user id: 1 user_id: 1 /contact_types: get: tags: - 4. Companies summary: List Contact Types operationId: 4Companies_listContactTypes description: >- Contact Types are categories into which you can place your People and Companies to classify your relationships with them. The Contact Types API allows you to retrieve the list of Contact Types associated with your Copper account. |Field|Type|Details| |---|---|---| |id|number|Unique identifier for the Contact Type.| |name|string|The name of the Contact Type.| parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: Contact Types / Contact Types headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Thu, 08 Jun 2017 18:08:04 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJWQzMzExMjA0MjY2MGFjNTgwMjQ0MzNhNGJhZDcwMmExBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMS93bGhRUXRNVkZUeENRQjJDdVByUEkvMEx3c2FqZDVJSVBFc2NFOFowQUU9BjsARg%3D%3D--17929806d9ee75df558e2ff85c3fd102d6399da1; domain=prosperworks.com; path=/; expires=Fri, 08-Jun-2018 18:08:04 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 9cfdc873-cbf6-4d14-a598-8d4353a77257 X-Runtime: schema: type: string example: '0.072946' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/4CompaniesListContactTypesResponse' examples: Contact Types: value: - id: 451490 name: Potential Customer - id: 451491 name: Current Customer - id: 451492 name: Uncategorized - id: 451493 name: Other /companies/{example_company_id}: parameters: - name: example_company_id in: path required: true schema: type: string get: tags: - 4. Companies summary: Fetch a Company by ID operationId: 4Companies_getById description: Fetch a Company by ID parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: Company headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 06 Jun 2017 00:00:58 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Wed, 06-Jun-2018 00:00:58 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: b46a9317-16c9-404c-a555-0e0711afeda3 X-Runtime: schema: type: string example: '0.107272' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/4CompaniesGetByIdResponse' examples: Company: value: tags: [] address: city: Scranton country: '' postal_code: '18501' state: PA street: 213 West Main Street assignee_id: null contact_type_id: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1483988828 date_modified: 1489018922 details: >- Keywords: Dunder Mifflin, Dunder Mifflin Infinity, Dunder Mifflin Paper, Dunder Mifflin Scranton, Dunder-mifflin, Dunder-mifflin Paper, Dunder-mifflin Scranton, Dundermifflin, NBC, NBC.com, Office 360, Ryan Howard, Scranton Office Supplies, The Office 360, The Office Tv, The Office Tv Series, The Office Tv Show email_domain: dundermifflin.com id: 9607580 interaction_count: 0 name: Dunder Mifflin (sample) phone_numbers: - category: work number: '4153554776' socials: [] websites: - category: work url: http://www.dundermifflin.com/index.shtml - category: work url: >- https://www.nbcstore.com/shop-by-show/the-office.html?shop_by_theme=7 - category: work url: http://dundermifflin.com put: tags: - 4. Companies summary: Update a Company operationId: 4Companies_updateCompany description: >- Updates are only applied to fields explicitly specified in the request body. For example, if an update request is made with an empty body, no updates will be made. To remove the value from a field, the request body must specify the target field value as 'null'. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/4CompaniesUpdateCompanyRequest' examples: Update a Company: value: details: This is an update responses: '200': description: Update Company headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 06 Jun 2017 00:25:12 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Wed, 06-Jun-2018 00:25:12 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: f0cd9bf0-53cd-4eee-bd22-19ab89ebbc14 X-Runtime: schema: type: string example: '0.273422' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/4CompaniesUpdateCompanyResponse' examples: Update Company: value: tags: [] address: city: Scranton country: '' postal_code: '18501' state: PA street: 213 West Main Street assignee_id: null contact_type_id: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1483988828 date_modified: 1496708712 details: This is an update email_domain: dundermifflin.com id: 9607580 interaction_count: 0 name: Dunder Mifflin (sample) phone_numbers: - category: work number: '4153554776' socials: [] websites: - category: work url: http://www.dundermifflin.com/index.shtml - category: work url: >- https://www.nbcstore.com/shop-by-show/the-office.html?shop_by_theme=7 - category: work url: http://dundermifflin.com /companies: post: tags: - 4. Companies summary: 'Create a New Company ' operationId: 4Companies_createNewCompany description: 'Create a New Company ' parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/4CompaniesCreateNewCompanyRequest' examples: 'Create a New Company ': value: address: city: San Francisco postal_code: '94105' state: CA street: 123 Main St details: This is a demo company email_domain: democompany.com name: Demo Company phone_numbers: - category: work number: 415-123-45678 responses: '200': description: create company headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 06 Jun 2017 00:12:10 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Wed, 06-Jun-2018 00:12:10 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: f7bd2356-dca6-4aff-8121-24d8164e9f11 X-Runtime: schema: type: string example: '0.355633' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/4CompaniesCreateNewCompanyResponse' examples: create company: value: tags: [] address: city: San Francisco country: null postal_code: '94105' state: CA street: 123 Main St assignee_id: null contact_type_id: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1496707930 date_modified: 1496707930 details: This is a demo company email_domain: democompany.com id: 13358412 interaction_count: 0 name: Demo Company phone_numbers: - category: work number: 415-123-45678 socials: [] websites: [] /companies/{delete_company_id}: parameters: - name: delete_company_id in: path required: true schema: type: string delete: tags: - 4. Companies summary: Delete a Company operationId: 4Companies_removeCompany description: This request permanently removes a Company from your Copper account. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: text/plain: examples: Delete a Company: value: '' schema: description: >- WARNING: Missing schema in media type object. Missing schema has been filled with this AnyType schema. responses: '200': description: Delete Person headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Mon, 05 Jun 2017 22:00:17 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Tue, 05-Jun-2018 22:00:17 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: ff7ea1c8-8eb5-47df-b368-f0623bd70bb3 X-Runtime: schema: type: string example: '0.204549' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/4CompaniesRemoveCompanyResponse' examples: Delete Person: value: id: 26443553 is_deleted: true /companies/search: post: tags: - 4. Companies summary: List Companies (Search) operationId: 4Companies_listCompanySearch description: >- The /search endpoint provides the ability to list Companies and sort the results by certain parameters. When multiple ciriteria are provided records meeting ALL criteria will be returned (the filtering criteria have an 'AND' relationship). To see examples of search request using the various parameters, click on the `Companies Search` dropdown on the right. Certain fields can be filtered by an empty value, i.e., filter records where the field is not specified. For Companies, these fields are: city, state, postal_code, tags, custom dropdown, custom multi-select fields. For an example of how this works, see `Search Companies by Empty Field`. Some fields (e.g. assignee_ids) can also filter for an empty value by specifying -2 as the ID. To search by custom fields, see `Search Entity by Custom Field` under `Custom Fields` folder. To change the number of records returned, change the "page_size" parameter. E.g., specify 200 for a page size of 200 records. | Field | Type | Details | Default | | ------------------------- | --------- | -------------------------------------------------------------------------------- | ------------- | | page_number | number | The page number (starting with 1) that you would like to view. | 1 | | page_size | number | The number of entries included in a page of results | 20 | | sort_by | string | The field on which to sort the results (see footnote 1). | date_modified | | sort_direction | string | The direction in which to sort the results. Possible values are: asc or desc. | asc | | name | string | Full name of the Company to search for. | none | | phone_number | string | Phone number of the Company to search for. | none | | email_domains | string | Email domains of the Company to search for. | none | | contact_type_ids | number[] | The contact type Ids to search for (see footnote 2). | none | | assignee_ids | number[] | The ids of Users that Company must be owned by, or -2 for Company with no owner. | none | | city | string | The city in which Company must be located. | none | | state | string | The state or province in which Company must be located. | none | | postal_code | string | The postal code in which Company must be located. | none | | country | string | The two character country code where Company must be located. | none | | tags | string[] | Filter Leads to those that match at least one of the tags specified. | none | | followed | number | 1: followed, 2: not followed | none | | age | number | The maximum age in seconds that each Company must be. | none | | minimum_interaction_count | number | The minimum number of interactions Company must have had. | none | | maximum_interaction_count | number | The maximum number of interactions Company must have had. | none | | minimum_interaction_date | timestamp | The Unix timestamp of the earliest date of the last interaction. | none | | maximum_interaction_date | timestamp | The Unix timestamp of the latest date of the last interaction. | none | | minimum_created_date | timestamp | The Unix timestamp of the earliest date Company are created. | none | | maximum_created_date | timestamp | The Unix timestamp of the latest date Company are created. | none | Footnote: 1. Possible fields are: name, phone, contact, contact_first_name, contact_last_name, date_modified, date_created, email_domain, city, state, country, zip, assignee, contact_group, last_interaction, interaction_count, primary_website. 2. See `List Contact Types` under Other Resources folder. 3. See `List Opportunities (Search)` under 5. Opportunities folder. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/4CompaniesListCompanySearchRequest' examples: List Companies (Search): value: contact_type_ids: - 6 page_size: 25 sort_by: name responses: '200': description: >- Search Companies by Email Domains / Search Companies by City / Search Companies by Postal Code / Companies Search / Search Companies by Custom Date Field / Search Companies by Last Interaction / Search Companies by Contact Type Ids headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: keep-alive Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Fri, 19 Jan 2018 00:32:42 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: nginx/1.12.2 Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTAyNmI5MGY4OTg5MDQ2NDBkNWQ1ZGUxNDU4MmQyMWJmBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMUlONTNKQUU3bGczS2pmV24vUzE0S3I5S3YxQUJhUzFuelRTQm9NcGF2OTQ9BjsARg%3D%3D--b2a6d835c09ab10305dde74393f501d2e36bf8e3; domain=lvh.me; path=/; expires=Sat, 19-Jan-2019 00:32:42 GMT; HttpOnly Status: schema: type: string example: 200 OK Transfer-Encoding: schema: type: string example: chunked Vary: schema: type: string example: Accept-Encoding X-Frame-Options: schema: type: string example: SAMEORIGIN X-PW-TOTAL: schema: type: string example: '1' X-Rack-CORS: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 8265eeb1a0035fd975db23e5dff02ab3 X-Runtime: schema: type: string example: '0.817376' X-UA-Compatible: schema: type: string example: IE=Edge content: application/json: schema: $ref: '#/components/schemas/4CompaniesListCompanySearchResponse' examples: Companies Search: value: - tags: [] address: city: San Francisco country: null postal_code: '94105' state: CA street: 123 Main St assignee_id: null contact_type_id: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1496707930 date_modified: 1496707932 details: This is a demo company email_domain: democompany.com id: 13358412 interaction_count: 0 name: Demo Company phone_numbers: - category: work number: 415-123-45678 socials: [] websites: - category: work url: http://democompany.com - tags: [] address: city: Scranton country: '' postal_code: '18501' state: PA street: 213 West Main Street assignee_id: null contact_type_id: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1483988828 date_modified: 1496708712 details: This is an update email_domain: dundermifflin.com id: 9607580 interaction_count: 0 name: Dunder Mifflin (sample) phone_numbers: - category: work number: '4153554776' socials: [] websites: - category: work url: http://www.dundermifflin.com/index.shtml - category: work url: >- https://www.nbcstore.com/shop-by-show/the-office.html?shop_by_theme=7 - category: work url: http://dundermifflin.com - tags: [] address: null assignee_id: 137658 contact_type_id: 451490 custom_fields: - custom_field_definition_id: 100764 value: Text fields are 255 chars or less! - custom_field_definition_id: 103481 value: Text area fields can have long text content date_created: 1496694264 date_modified: 1496694270 details: null email_domain: noemail.com id: 13349319 interaction_count: 0 name: Noemail phone_numbers: [] socials: [] websites: [] - tags: [] address: city: San Francisco country: '' postal_code: '94105' state: CA street: 221 Main Street Suite 1350 assignee_id: null contact_type_id: 451493 custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1483988828 date_modified: 1489018922 details: >- Overview: ProsperWorks is the world's first zero input CRM. Designed specifically for Google Apps, ProsperWorks helps companies sell more faster by identifying, organizing and tracking sales opportunities right in Gmail, Calendar and Google Drive. By removing the need for data entry, salespeople can focus on developing business and managers can finally have accurate forecasting with real time activity tracking. ProsperWorks was founded by Jon Lee, Kelly Cheng and Andrew Hu with the commitment to empower small business sales and marketing. Jon was Founder/CEO of three big data companies that solved optimization problems in advertising, gaming and photo sharing. Each company realized successful exits. The team also includes the leaders in engineering and product from Facebook Mobile, BaseCRM and Salesforce. ProsperWorks has raised $10 million in funding from True Ventures, Bloomberg Beta, Crunchfund and other high-profile angel investors. ProsperWorks is based in San Francisco, CA. Approx. Number of Employees: 30 Founded: 2011 Keywords: Automotive, CRM, Finance, Google, Google Apps, Leadership, Management, Podcasting, SAAS, Sales, Small Business email_domain: prosperworks.com id: 9607579 interaction_count: 0 name: ProsperWorks phone_numbers: - category: work number: '4153554776' socials: - category: linkedin url: https://www.linkedin.com/company/prosperworks-inc- - category: twitter url: https://twitter.com/ProsperWorks - category: facebook url: https://www.facebook.com/ProsperWorks - category: klout url: http://klout.com/ProsperWorks - category: other url: https://angel.co/prosperworks - category: other url: https://plus.google.com/u/0/103594665195397142807 - category: other url: http://www.crunchbase.com/organization/prosperworks websites: - category: work url: www.prosperworks.com - category: work url: https://www.prosperworks.com - tags: [] address: city: Philadelphia country: '' postal_code: '19135' state: PA street: 543 Washington Ave assignee_id: null contact_type_id: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1483988828 date_modified: 1489018922 details: null email_domain: null id: 9607581 interaction_count: 0 name: Sabre Inc (sample) phone_numbers: [] socials: [] websites: [] Search Companies by City: value: - tags: [] address: city: Philadelphia country: '' postal_code: '19135' state: PA street: 543 Washington Ave assignee_id: 2 contact_type_id: 6 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434867 date_modified: 1516320789 details: null email_domain: null id: 4 interaction_count: 0 name: Sabre Inc (sample) phone_numbers: [] socials: [] websites: [] Search Companies by Contact Type Ids: value: - tags: [] address: city: Philadelphia country: '' postal_code: '19135' state: PA street: 543 Washington Ave assignee_id: 2 contact_type_id: 6 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434867 date_modified: 1516320789 details: null email_domain: null id: 4 interaction_count: 0 name: Sabre Inc (sample) phone_numbers: [] socials: [] websites: [] Search Companies by Custom Date Field: value: - tags: - tag1 address: city: Philadelphia country: US postal_code: '19135' state: PA street: 543 Washington Ave assignee_id: 2 contact_type_id: 6 custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1515434867 date_modified: 1516324052 details: null email_domain: null id: 4 interaction_count: 0 name: Sabre Inc (sample) phone_numbers: [] socials: [] websites: [] Search Companies by Email Domains: value: - tags: [] address: city: Scranton country: null postal_code: '18501' state: PA street: 213 West Main Street assignee_id: null contact_type_id: null custom_fields: [] date_created: 1519852352 date_modified: 1519852398 details: null email_domain: dundermifflin.com id: 2 interaction_count: 0 name: Dunder Mifflin (sample) phone_numbers: - category: work number: '4153554776' socials: [] websites: - category: work url: http://www.dundermifflin.com/index.shtml Search Companies by Last Interaction: value: - tags: [] address: city: San Francisco country: '' postal_code: '94105' state: CA street: 221 Main Street Suite 1350 assignee_id: null contact_type_id: 8 custom_fields: - custom_field_definition_id: 12 value: - 9 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434866 date_modified: 1516324063 details: null email_domain: prosperworks.com id: 2 interaction_count: 2 name: ProsperWorks phone_numbers: - category: work number: '4153554776' socials: - category: linkedin url: https://www.linkedin.com/company/prosperworks-inc- websites: - category: work url: www.prosperworks.com - category: work url: https://www.prosperworks.com - tags: - tag1 address: city: Philadelphia country: US postal_code: '19135' state: PA street: 543 Washington Ave assignee_id: 2 contact_type_id: 6 custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1515434867 date_modified: 1516324258 details: null email_domain: null id: 4 interaction_count: 2 name: Sabre Inc (sample) phone_numbers: [] socials: [] websites: [] Search Companies by Postal Code: value: - tags: [] address: city: Scranton country: US postal_code: '18501' state: PA street: 213 West Main Street assignee_id: null contact_type_id: 5 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434866 date_modified: 1516323758 details: null email_domain: dundermifflin.com id: 3 interaction_count: 0 name: Dunder Mifflin (sample) phone_numbers: - category: work number: '4153554776' socials: [] websites: - category: work url: http://www.dundermifflin.com/index.shtml /companies/{example_company_id}/activities: parameters: - name: example_company_id in: path required: true schema: type: string post: tags: - 4. Companies summary: See a Company's Activities operationId: 4Companies_getCompanyActivities description: >- This request will show the Activity entries created for a specific Company. For more details please see the notes at the [/activities endpoint](https://dev.prosperworks.com). parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/4CompaniesGetCompanyActivitiesRequest' examples: See a Company's Activities: value: activity_types: - category: user id: 1 responses: '200': description: Company Activities headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 06 Jun 2017 01:00:13 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Wed, 06-Jun-2018 01:00:13 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: fea41062-1a62-4dfd-84b3-4ea2acb4ccfc X-Runtime: schema: type: string example: '0.150700' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/4CompaniesGetCompanyActivitiesResponse' examples: Company Activities: value: - activity_date: 1522695004 date_created: 1522695010 date_modified: 1522695004 details: Call with Alex id: 72 new_value: null old_value: null parent: id: 1 type: company type: category: user id: 1 user_id: 1 - activity_date: 1522694372 date_created: 1522694392 date_modified: 1522694372 details: Call with Rob id: 70 new_value: null old_value: null parent: id: 2 type: person type: category: user id: 1 user_id: 1 /opportunities/{example_opportunity_id}: parameters: - name: example_opportunity_id in: path required: true schema: type: string get: tags: - 5. Opportunities summary: Fetch an Opportunity by ID operationId: 5Opportunities_getOpportunityById description: Fetch an Opportunity by ID parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: Get Opportunity headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 06 Jun 2017 01:36:08 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Wed, 06-Jun-2018 01:36:08 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 02c9a256-b17c-4ea3-a8ea-c4be071d81f8 X-Runtime: schema: type: string example: '0.105754' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/5OpportunitiesGetOpportunityByIdResponse' examples: Get Opportunity: value: tags: [] assignee_id: null close_date: 1/23/2017 company_id: 9607580 company_name: Dunder Mifflin (sample) custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null customer_source_id: 331241 date_created: 1483988829 date_modified: 1489018922 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 2827698 interaction_count: 0 loss_reason_id: null monetary_value: 250000 name: 8 New Copy Machines (sample) pipeline_id: 213214 pipeline_stage_id: 987790 primary_contact_id: null priority: None status: Open win_probability: 5 put: tags: - 5. Opportunities summary: Update an Opportunity operationId: 5Opportunities_updateOpportunityFields description: >- Updates are only applied to fields explicitly specified in the request body. For example, if an update request is made with an empty body, no updates will be made. To remove the value from a field, the request body must specify the target field value as 'null'. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: >- #/components/schemas/5OpportunitiesUpdateOpportunityFieldsRequest examples: Update an Opportunity: value: details: This is an update responses: '200': description: Update Opportunity headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 06 Jun 2017 19:10:56 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Wed, 06-Jun-2018 19:10:56 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 78aeea6a-397f-4d4e-acdb-5fc21b44780f X-Runtime: schema: type: string example: '0.807650' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: >- #/components/schemas/5OpportunitiesUpdateOpportunityFieldsResponse examples: Update Opportunity: value: tags: [] assignee_id: null close_date: 1/23/2017 company_id: 9607580 company_name: Dunder Mifflin (sample) custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null customer_source_id: 331241 date_created: 1483988829 date_modified: 1496776255 details: This is an update id: 2827698 interaction_count: 0 loss_reason_id: null monetary_value: 250000 name: 8 New Copy Machines (sample) pipeline_id: 213214 pipeline_stage_id: 987790 primary_contact_id: null priority: None status: Open win_probability: 5 /opportunities: post: tags: - 5. Opportunities summary: Create a New Opportunity operationId: 5Opportunities_createNewOpportunity description: |- The following fields are required for this request: "name" "primary_contact_id" parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/5OpportunitiesCreateNewOpportunityRequest' examples: Create a New Opportunity: value: customer_source_id: 331242 name: New Demo Opportunity primary_contact_id: 27140359 responses: '200': description: New Opportunity headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 08 Aug 2017 02:16:40 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTU0NDE4YTkzZTBhMzg5MGY2MGI5MGU4YWU1YzhjMWQzBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9ra1JiT1k5dWVXTVJvaU5PN3dNWHVBN1NyZnpsWTlGU0ZzcUUwMllDUzQ9BjsARg%3D%3D--94d0bdf1bdc3e1353cfd15afd73dbdbc07d09908; domain=prosperworks.com; path=/; expires=Wed, 08-Aug-2018 02:16:40 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 3151e39c-8381-4be6-a68c-c3d205946c26 X-Runtime: schema: type: string example: '1.176740' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: >- #/components/schemas/5OpportunitiesCreateNewOpportunityResponse examples: New Opportunity: value: tags: [] assignee_id: null close_date: null company_id: 13349319 company_name: Noemail custom_fields: - custom_field_definition_id: 126240 value: null - custom_field_definition_id: 103481 value: null - custom_field_definition_id: 100764 value: null customer_source_id: 331242 date_created: 1502158599 date_last_contacted: null date_modified: 1502158599 details: null id: 4956209 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_value: null name: New Demo Opportunity pipeline_id: 213214 pipeline_stage_id: 987790 primary_contact_id: 27140359 priority: None status: Open win_probability: 5 /opportunities/{delete_opportunity_id}: parameters: - name: delete_opportunity_id in: path required: true schema: type: string delete: tags: - 5. Opportunities summary: Delete an Opportunity operationId: 5Opportunities_removeOpportunityRecord description: This request permanently removes a record from your Copper account. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: text/plain: examples: Delete an Opportunity: value: '' schema: description: >- WARNING: Missing schema in media type object. Missing schema has been filled with this AnyType schema. responses: '200': description: Delete Opportunity headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Mon, 05 Jun 2017 22:00:17 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Tue, 05-Jun-2018 22:00:17 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: ff7ea1c8-8eb5-47df-b368-f0623bd70bb3 X-Runtime: schema: type: string example: '0.204549' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: >- #/components/schemas/5OpportunitiesRemoveOpportunityRecordResponse examples: Delete Opportunity: value: id: 99999999 is_deleted: true /opportunities/search: post: tags: - 5. Opportunities summary: List Opportunities (Search) operationId: 5Opportunities_listByCriteria description: >- The /search endpoint provides the ability to list records and sort the results by certain parameters. When multiple ciriteria are provided then records meeting ALL criteria will be returned (the filtering criteria have an 'AND' relationship). To see examples of search request using the various parameters, click on the `Opportunities Search` dropdown on the right.Certain fields can be filtered by an empty value, i.e., filter records where the field is not specified. For Opportunities, these fields are: company_ids, tags, custom dropdown, custom multi-select fields. For an example of how this works, see `Search Opportunities by Empty Field`. Some fields (e.g. assignee_ids) can also filter for an empty value by specifying -2 as the ID. To search by custom fields, see `Search Entity by Custom Field` under `Custom Fields` folder. To change the number of records returned, change the "page_size" parameter. E.g., specify 200 for a page size of 200 records. | Field | Type | Details | Default | | ------------------------- | --------- | -------------------------------------------------------------------------------------------- | ------- | | page_number | number | The page number (starting with 1) that you would like to view. | 1 | | page_size | number | The number of entries included in a page of results | 20 | | sort_by | string | The field on which to sort the results (see footnote 1). | name | | sort_direction | string | The direction in which to sort the results. Possible values are: asc or desc. | asc | | name | string | Full name of the Opportunity to search for. | none | | assignee_ids | number[] | The ids of Users that Opportunities must be owned by, or -2 for Opportunities with no owner. | none | | status_ids | number[] | An array of Opportunity status IDs as integers. The integer values are 0, 1, 2, 3, for "Open", "Won", "Lost", and "Abandoned", respectively. | none | | pipeline_ids | number[] | An array of pipeline IDs. | none | | pipeline_stage_ids | number[] | An array of pipeline stage IDs. | none | | priority_ids | number[] | An array of priority IDs. | none | | customer_source_ids | number[] | An array of customer source IDs, or -2 for no customer source. | none | | loss_reason_ids | number[] | An array of loss reason IDs, or -2 for no loss reason. | none | | company_ids | number[] | An array of company IDs. | none | | tags | string[] | Filter Opportunities to those that match at least one of the tags specified. | none | | followed | number | 1: followed, 2: not followed | none | | minimum_monetary_value | number | The minimum monetary value Opportunities must have. | none | | maximum_monetary_value | number | The maximum monetary value Opportunities must have. | none | | minimum_interaction_count | number | The minimum number of interactions Opportunities must have had. | none | | maximum_interaction_count | number | The maximum number of interactions Opportunities must have had. | none | | minimum_close_date | timestamp | The Unix timestamp of the earliest close date. | none | | maximum_close_date | timestamp | The Unix timestamp of the latest close date. | none | | minimum_interaction_date | timestamp | The Unix timestamp of the earliest date of the last interaction. | none | | maximum_interaction_date | timestamp | The Unix timestamp of the latest date of the last interaction. | none | | minimum_stage_change_date | timestamp | The Unix timestamp of the earliest date of a state change. | none | | maximum_stage_change_date | timestamp | The Unix timestamp of the latest date of a state change. | none | | minimum_created_date | timestamp | The Unix timestamp of the earliest date Opportunities are created. | none | | maximum_created_date | timestamp | The Unix timestamp of the latest date Opportunities are created. | none | | minimum_modified_date | timestamp | The Unix timestamp of the earliest date Opportunities are modified. | none | | maximum_modified_date | timestamp | The Unix timestamp of the latest date Opportunities are modified. | none | Foonotes: 1. Possible fields are: name, account, company_name, value, assignee, customer_source_id, date_modified, date_created, contact, stage, status, close_date, source, priority, last_interaction, interaction_count, deal_last_stage, win_probability. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/5OpportunitiesListByCriteriaRequest' examples: List Opportunities (Search): value: loss_reason_ids: - -2 page_size: 25 sort_by: name Search Opportunities by Name: value: name: 500 Keyboards (sample) responses: '200': description: >- Search Opportunities by Tags / List Opportunities in Groups of 200 / Search Opportunities by Multi-Select Dropdown Set to Empty / Search Opportunities by Date Stage Changed / Search Opportunities by Interaction Count / Opportunities Search / Search Opportunities by Value / Search Opportunities by Custom Date Field / Search Opportunities by Priorities / Search Opportunities by Customer Source Ids / Search Opportunities by Date Last Interacted / Search Opportunities by Created Date / Search Opportunities by Close Date / Search Opportunities by Assignee Ids / Search Opportunities by Company Ids / Search Opportunities by Statuses / Search Opportunities by Custom Multi-Select Dropdown / Search Opportunities by Followed / Search Opportunities by Pipeline Stage Ids / Search Opportunities by Name / Search Opportunities by Loss Reason Ids / Search Opportunities by Name headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Fri, 06 Oct 2017 21:48:49 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTUyMGI5OGI1Mjk4MDkzZGU2Y2FhNTE3OGU1YjdjY2JlBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMThEdFlvaTN2UjhWN0x3TDVUYy91SEdvQytKZEoyT0RKcU84Yk1rY1hPenM9BjsARg%3D%3D--eb5fefae0104c4fdebce5cc089b5f966f2b38323; domain=prosperworks.com; path=/; expires=Sat, 06-Oct-2018 21:48:49 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Pw-Total: schema: type: string example: '1' X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 96fd7751-a0b5-460a-878b-3a2c63aee0b8 X-Runtime: schema: type: string example: '0.143182' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/5OpportunitiesListByCriteriaResponse' examples: List Opportunities in Groups of 200: value: - tags: [] assignee_id: 2 close_date: 1/15/2018 company_id: 3 company_name: Dunder Mifflin (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 6 date_created: 1515434869 date_last_contacted: 1516737600 date_lead_created: null date_modified: 1516820005 date_stage_changed: 1515434869 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 4 interaction_count: 2 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 75000 name: 25 Office Chairs (sample) pipeline_id: 3 pipeline_stage_id: 13 primary_contact_id: 5 priority: None status: Open win_probability: 40 - tags: - tag1 assignee_id: null close_date: 1/13/2018 company_id: 4 company_name: Sabre Inc (sample) custom_fields: - custom_field_definition_id: 5 value: 6 - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null customer_source_id: null date_created: 1515434870 date_last_contacted: null date_lead_created: null date_modified: 1516736568 date_stage_changed: 1515434870 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 5 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 50000 name: 500 Keyboards (sample) pipeline_id: 3 pipeline_stage_id: 11 primary_contact_id: 3 priority: None status: Open win_probability: 10 - tags: [] assignee_id: null close_date: 1/22/2018 company_id: 3 company_name: Dunder Mifflin (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 5 date_created: 1515434867 date_last_contacted: null date_lead_created: null date_modified: 1516736704 date_stage_changed: 1515434867 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 3 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 250000 name: 8 New Copy Machines (sample) pipeline_id: 3 pipeline_stage_id: 10 primary_contact_id: 3 priority: High status: Open win_probability: 5 - tags: [] assignee_id: null close_date: 2/8/2018 company_id: 4 company_name: Sabre Inc (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 5 date_created: 1515458602 date_last_contacted: null date_lead_created: null date_modified: 1516736700 date_stage_changed: 1515458602 details: null id: 6 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: null monetary_value: null name: Sell stuff pipeline_id: 3 pipeline_stage_id: 10 primary_contact_id: 6 priority: None status: Lost win_probability: 5 Opportunities Search: value: - tags: [] assignee_id: null close_date: 1/16/2017 company_id: 9607580 company_name: Dunder Mifflin (sample) custom_fields: - custom_field_definition_id: 126240 value: null - custom_field_definition_id: 103481 value: null - custom_field_definition_id: 100764 value: null customer_source_id: 331242 date_created: 1483988829 date_last_contacted: null date_lead_created: null date_modified: 1489018922 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 2827699 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_value: 75000 name: 25 Office Chairs (sample) pipeline_id: 213214 pipeline_stage_id: 987793 primary_contact_id: null priority: None status: Open win_probability: 40 - tags: [] assignee_id: null close_date: 1/14/2017 company_id: 9607581 company_name: Sabre Inc (sample) custom_fields: - custom_field_definition_id: 126240 value: null - custom_field_definition_id: 103481 value: null - custom_field_definition_id: 100764 value: null customer_source_id: null date_created: 1483988829 date_last_contacted: null date_lead_created: null date_modified: 1496943803 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 2827700 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_value: 50000 name: 500 Keyboards (sample) pipeline_id: 213214 pipeline_stage_id: 987791 primary_contact_id: null priority: None status: Open win_probability: 10 - tags: [] assignee_id: null close_date: 1/23/2017 company_id: 9607580 company_name: Dunder Mifflin (sample) custom_fields: - custom_field_definition_id: 126240 value: null - custom_field_definition_id: 103481 value: null - custom_field_definition_id: 100764 value: null customer_source_id: 331241 date_created: 1483988829 date_last_contacted: null date_lead_created: null date_modified: 1496776255 details: This is an update id: 2827698 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_value: 250000 name: 8 New Copy Machines (sample) pipeline_id: 213214 pipeline_stage_id: 987790 primary_contact_id: null priority: None status: Open win_probability: 5 - tags: [] assignee_id: null close_date: null company_id: null company_name: null custom_fields: - custom_field_definition_id: 126240 value: null - custom_field_definition_id: 103481 value: null - custom_field_definition_id: 100764 value: null customer_source_id: null date_created: 1490114507 date_last_contacted: null date_lead_created: null date_modified: 1496700017 details: null id: 3826510 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_value: null name: Demo Opportunity pipeline_id: 213214 pipeline_stage_id: 987790 primary_contact_id: null priority: None status: Open win_probability: 5 - tags: [] assignee_id: null close_date: null company_id: 13349319 company_name: Noemail custom_fields: - custom_field_definition_id: 100764 value: Text fields are 255 chars or less! - custom_field_definition_id: 103481 value: Text area fields can have long text content - custom_field_definition_id: 126240 value: null customer_source_id: null date_created: 1496694264 date_last_contacted: 1496703593 date_lead_created: 1496692663 date_modified: 1496943309 details: '' id: 4417020 interaction_count: 1 leads_converted_from: - converted_timestamp: 1496694264 lead_id: 11393303 loss_reason_id: null monetary_value: 1000 name: Demo Project pipeline_id: 213214 pipeline_stage_id: 987790 primary_contact_id: 27140359 priority: null status: Open win_probability: 0 - tags: [] assignee_id: 137658 close_date: 2/10/2017 company_id: null company_name: null custom_fields: - custom_field_definition_id: 126240 value: null - custom_field_definition_id: 103481 value: null - custom_field_definition_id: 100764 value: null customer_source_id: null date_created: 1484096886 date_last_contacted: null date_lead_created: null date_modified: 1489018921 details: null id: 2841646 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_value: null name: ejfpvoiewjrvoierjvoierv pipeline_id: 213214 pipeline_stage_id: 987790 primary_contact_id: null priority: None status: Open win_probability: 5 - tags: [] assignee_id: null close_date: null company_id: 13349319 company_name: Noemail custom_fields: - custom_field_definition_id: 126240 value: null - custom_field_definition_id: 103481 value: null - custom_field_definition_id: 100764 value: null customer_source_id: null date_created: 1496713840 date_last_contacted: 1496703593 date_lead_created: null date_modified: 1496943302 details: null id: 4418567 interaction_count: 1 leads_converted_from: [] loss_reason_id: null monetary_value: null name: New Demo Opportunity pipeline_id: 213214 pipeline_stage_id: 987790 primary_contact_id: 27140359 priority: None status: Open win_probability: 5 - tags: [] assignee_id: null close_date: null company_id: 13349319 company_name: Noemail custom_fields: - custom_field_definition_id: 126240 value: null - custom_field_definition_id: 103481 value: null - custom_field_definition_id: 100764 value: null customer_source_id: 331242 date_created: 1502158599 date_last_contacted: null date_lead_created: null date_modified: 1502158600 details: null id: 4956209 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_value: null name: New Demo Opportunity pipeline_id: 213214 pipeline_stage_id: 987790 primary_contact_id: 27140359 priority: None status: Open win_probability: 5 Search Opportunities by Assignee Ids: value: - tags: [] assignee_id: 2 close_date: 1/15/2018 company_id: 3 company_name: Dunder Mifflin (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 6 date_created: 1515434869 date_last_contacted: null date_lead_created: null date_modified: 1516310945 date_stage_changed: 1515434869 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 4 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 75000 name: 25 Office Chairs (sample) pipeline_id: 3 pipeline_stage_id: 13 primary_contact_id: 5 priority: None status: Open win_probability: 40 Search Opportunities by Close Date: value: - tags: [] assignee_id: null close_date: 1/13/2018 company_id: 4 company_name: Sabre Inc (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: null date_created: 1515434870 date_last_contacted: null date_lead_created: null date_modified: 1516673290 date_stage_changed: 1515434870 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 5 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 50000 name: 500 Keyboards (sample) pipeline_id: 3 pipeline_stage_id: 11 primary_contact_id: 3 priority: None status: Open win_probability: 10 Search Opportunities by Company Ids: value: - tags: [] assignee_id: 2 close_date: 1/15/2018 company_id: 3 company_name: Dunder Mifflin (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 6 date_created: 1515434869 date_last_contacted: null date_lead_created: null date_modified: 1516310945 date_stage_changed: 1515434869 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 4 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 75000 name: 25 Office Chairs (sample) pipeline_id: 3 pipeline_stage_id: 13 primary_contact_id: 5 priority: None status: Open win_probability: 40 - tags: [] assignee_id: null close_date: 1/22/2018 company_id: 3 company_name: Dunder Mifflin (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 5 date_created: 1515434867 date_last_contacted: null date_lead_created: null date_modified: 1516673603 date_stage_changed: 1515434867 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 3 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 250000 name: 8 New Copy Machines (sample) pipeline_id: 3 pipeline_stage_id: 10 primary_contact_id: 3 priority: High status: Open win_probability: 5 Search Opportunities by Created Date: value: - tags: [] assignee_id: null close_date: 1/13/2018 company_id: 4 company_name: Sabre Inc (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: null date_created: 1515434870 date_last_contacted: null date_lead_created: null date_modified: 1516673290 date_stage_changed: 1515434870 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 5 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 50000 name: 500 Keyboards (sample) pipeline_id: 3 pipeline_stage_id: 11 primary_contact_id: 3 priority: None status: Open win_probability: 10 Search Opportunities by Custom Date Field: value: - tags: - tag1 assignee_id: null close_date: 1/13/2018 company_id: 4 company_name: Sabre Inc (sample) custom_fields: - custom_field_definition_id: 5 value: 6 - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null customer_source_id: null date_created: 1515434870 date_last_contacted: null date_lead_created: null date_modified: 1516736568 date_stage_changed: 1515434870 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 5 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 50000 name: 500 Keyboards (sample) pipeline_id: 3 pipeline_stage_id: 11 primary_contact_id: 3 priority: None status: Open win_probability: 10 Search Opportunities by Custom Multi-Select Dropdown: value: - tags: - tag1 assignee_id: null close_date: 1/13/2018 company_id: 4 company_name: Sabre Inc (sample) custom_fields: - custom_field_definition_id: 5 value: 6 - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null customer_source_id: null date_created: 1515434870 date_last_contacted: null date_lead_created: null date_modified: 1516736568 date_stage_changed: 1515434870 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 5 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 50000 name: 500 Keyboards (sample) pipeline_id: 3 pipeline_stage_id: 11 primary_contact_id: 3 priority: None status: Open win_probability: 10 Search Opportunities by Customer Source Ids: value: - tags: [] assignee_id: null close_date: 1/22/2018 company_id: 3 company_name: Dunder Mifflin (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 5 date_created: 1515434867 date_last_contacted: null date_lead_created: null date_modified: 1516673603 date_stage_changed: 1515434867 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 3 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 250000 name: 8 New Copy Machines (sample) pipeline_id: 3 pipeline_stage_id: 10 primary_contact_id: 3 priority: High status: Open win_probability: 5 - tags: [] assignee_id: null close_date: 2/8/2018 company_id: 4 company_name: Sabre Inc (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 5 date_created: 1515458602 date_last_contacted: null date_lead_created: null date_modified: 1516674120 date_stage_changed: 1515458602 details: null id: 6 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: null monetary_value: null name: Sell stuff pipeline_id: 3 pipeline_stage_id: 10 primary_contact_id: 6 priority: None status: Open win_probability: 5 Search Opportunities by Date Last Interacted: value: - tags: [] assignee_id: 2 close_date: 1/15/2018 company_id: 3 company_name: Dunder Mifflin (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 6 date_created: 1515434869 date_last_contacted: 1516737600 date_lead_created: null date_modified: 1516737667 date_stage_changed: 1515434869 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 4 interaction_count: 2 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 75000 name: 25 Office Chairs (sample) pipeline_id: 3 pipeline_stage_id: 13 primary_contact_id: 5 priority: None status: Open win_probability: 40 Search Opportunities by Date Stage Changed: value: - tags: [] assignee_id: 2 close_date: 1/15/2018 company_id: 3 company_name: Dunder Mifflin (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 6 date_created: 1515434869 date_last_contacted: 1516737600 date_lead_created: null date_modified: 1516737667 date_stage_changed: 1515434869 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 4 interaction_count: 2 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 75000 name: 25 Office Chairs (sample) pipeline_id: 3 pipeline_stage_id: 13 primary_contact_id: 5 priority: None status: Open win_probability: 40 Search Opportunities by Followed: value: - tags: - tag1 assignee_id: null close_date: 1/13/2018 company_id: 4 company_name: Sabre Inc (sample) custom_fields: - custom_field_definition_id: 5 value: 6 - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null customer_source_id: null date_created: 1515434870 date_last_contacted: null date_lead_created: null date_modified: 1516736568 date_stage_changed: 1515434870 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 5 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 50000 name: 500 Keyboards (sample) pipeline_id: 3 pipeline_stage_id: 11 primary_contact_id: 3 priority: None status: Open win_probability: 10 Search Opportunities by Interaction Count: value: - tags: [] assignee_id: 2 close_date: 1/15/2018 company_id: 3 company_name: Dunder Mifflin (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 6 date_created: 1515434869 date_last_contacted: 1516737600 date_lead_created: null date_modified: 1516737667 date_stage_changed: 1515434869 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 4 interaction_count: 2 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 75000 name: 25 Office Chairs (sample) pipeline_id: 3 pipeline_stage_id: 13 primary_contact_id: 5 priority: None status: Open win_probability: 40 Search Opportunities by Loss Reason Ids: value: - tags: [] assignee_id: 2 close_date: 1/15/2018 company_id: 3 company_name: Dunder Mifflin (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 6 date_created: 1515434869 date_last_contacted: null date_lead_created: null date_modified: 1516310945 date_stage_changed: 1515434869 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 4 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 75000 name: 25 Office Chairs (sample) pipeline_id: 3 pipeline_stage_id: 13 primary_contact_id: 5 priority: None status: Open win_probability: 40 - tags: [] assignee_id: null close_date: 1/13/2018 company_id: 4 company_name: Sabre Inc (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: null date_created: 1515434870 date_last_contacted: null date_lead_created: null date_modified: 1516673290 date_stage_changed: 1515434870 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 5 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 50000 name: 500 Keyboards (sample) pipeline_id: 3 pipeline_stage_id: 11 primary_contact_id: 3 priority: None status: Open win_probability: 10 - tags: [] assignee_id: null close_date: 1/22/2018 company_id: 3 company_name: Dunder Mifflin (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 5 date_created: 1515434867 date_last_contacted: null date_lead_created: null date_modified: 1516673603 date_stage_changed: 1515434867 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 3 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 250000 name: 8 New Copy Machines (sample) pipeline_id: 3 pipeline_stage_id: 10 primary_contact_id: 3 priority: High status: Open win_probability: 5 - tags: [] assignee_id: null close_date: 2/8/2018 company_id: 4 company_name: Sabre Inc (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 5 date_created: 1515458602 date_last_contacted: null date_lead_created: null date_modified: 1516733449 date_stage_changed: 1515458602 details: null id: 6 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: null monetary_value: null name: Sell stuff pipeline_id: 3 pipeline_stage_id: 10 primary_contact_id: 6 priority: None status: Lost win_probability: 5 Search Opportunities by Multi-Select Dropdown Set to Empty: value: - tags: [] assignee_id: 2 close_date: 1/15/2018 company_id: 3 company_name: Dunder Mifflin (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 6 date_created: 1515434869 date_last_contacted: null date_lead_created: null date_modified: 1516736722 date_stage_changed: 1515434869 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 4 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 75000 name: 25 Office Chairs (sample) pipeline_id: 3 pipeline_stage_id: 13 primary_contact_id: 5 priority: None status: Open win_probability: 40 - tags: [] assignee_id: null close_date: 1/22/2018 company_id: 3 company_name: Dunder Mifflin (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 5 date_created: 1515434867 date_last_contacted: null date_lead_created: null date_modified: 1516736704 date_stage_changed: 1515434867 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 3 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 250000 name: 8 New Copy Machines (sample) pipeline_id: 3 pipeline_stage_id: 10 primary_contact_id: 3 priority: High status: Open win_probability: 5 - tags: [] assignee_id: null close_date: 2/8/2018 company_id: 4 company_name: Sabre Inc (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 5 date_created: 1515458602 date_last_contacted: null date_lead_created: null date_modified: 1516736700 date_stage_changed: 1515458602 details: null id: 6 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: null monetary_value: null name: Sell stuff pipeline_id: 3 pipeline_stage_id: 10 primary_contact_id: 6 priority: None status: Lost win_probability: 5 Search Opportunities by Name: value: - tags: [] assignee_id: null close_date: 1/14/2017 company_id: 9607581 company_name: Sabre Inc (sample) custom_fields: - custom_field_definition_id: 126240 value: null - custom_field_definition_id: 103481 value: null - custom_field_definition_id: 100764 value: null customer_source_id: null date_created: 1483988829 date_last_contacted: null date_lead_created: null date_modified: 1496943803 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 2827700 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_value: 50000 name: 500 Keyboards (sample) pipeline_id: 213214 pipeline_stage_id: 987791 primary_contact_id: null priority: None status: Open win_probability: 10 Search Opportunities by Pipeline Stage Ids: value: - tags: [] assignee_id: 2 close_date: 1/15/2018 company_id: 3 company_name: Dunder Mifflin (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 6 date_created: 1515434869 date_last_contacted: null date_lead_created: null date_modified: 1516310945 date_stage_changed: 1515434869 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 4 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 75000 name: 25 Office Chairs (sample) pipeline_id: 3 pipeline_stage_id: 13 primary_contact_id: 5 priority: None status: Open win_probability: 40 Search Opportunities by Priorities: value: - tags: [] assignee_id: null close_date: 1/22/2018 company_id: 3 company_name: Dunder Mifflin (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 5 date_created: 1515434867 date_last_contacted: null date_lead_created: null date_modified: 1516673603 date_stage_changed: 1515434867 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 3 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 250000 name: 8 New Copy Machines (sample) pipeline_id: 3 pipeline_stage_id: 10 primary_contact_id: 3 priority: High status: Open win_probability: 5 Search Opportunities by Statuses: value: - tags: [] assignee_id: 2 close_date: 1/15/2018 company_id: 3 company_name: Dunder Mifflin (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 6 date_created: 1515434869 date_last_contacted: null date_lead_created: null date_modified: 1516310945 date_stage_changed: 1515434869 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 4 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 75000 name: 25 Office Chairs (sample) pipeline_id: 3 pipeline_stage_id: 13 primary_contact_id: 5 priority: None status: Open win_probability: 40 - tags: [] assignee_id: null close_date: 1/13/2018 company_id: 4 company_name: Sabre Inc (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: null date_created: 1515434870 date_last_contacted: null date_lead_created: null date_modified: 1516673290 date_stage_changed: 1515434870 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 5 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 50000 name: 500 Keyboards (sample) pipeline_id: 3 pipeline_stage_id: 11 primary_contact_id: 3 priority: None status: Open win_probability: 10 - tags: [] assignee_id: null close_date: 1/22/2018 company_id: 3 company_name: Dunder Mifflin (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 5 date_created: 1515434867 date_last_contacted: null date_lead_created: null date_modified: 1516673297 date_stage_changed: 1515434867 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 3 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 250000 name: 8 New Copy Machines (sample) pipeline_id: 3 pipeline_stage_id: 10 primary_contact_id: 3 priority: None status: Open win_probability: 5 - tags: [] assignee_id: null close_date: 2/8/2018 company_id: 4 company_name: Sabre Inc (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: null date_created: 1515458602 date_last_contacted: null date_lead_created: null date_modified: 1516673280 date_stage_changed: 1515458602 details: null id: 6 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: null monetary_value: null name: Sell stuff pipeline_id: 3 pipeline_stage_id: 10 primary_contact_id: 6 priority: None status: Open win_probability: 5 Search Opportunities by Tags: value: - tags: - tag1 assignee_id: null close_date: 1/13/2018 company_id: 4 company_name: Sabre Inc (sample) custom_fields: - custom_field_definition_id: 5 value: 6 - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null customer_source_id: null date_created: 1515434870 date_last_contacted: null date_lead_created: null date_modified: 1516736568 date_stage_changed: 1515434870 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 5 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 50000 name: 500 Keyboards (sample) pipeline_id: 3 pipeline_stage_id: 11 primary_contact_id: 3 priority: None status: Open win_probability: 10 Search Opportunities by Value: value: - tags: [] assignee_id: 2 close_date: 1/15/2018 company_id: 3 company_name: Dunder Mifflin (sample) custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null customer_source_id: 6 date_created: 1515434869 date_last_contacted: null date_lead_created: null date_modified: 1516310945 date_stage_changed: 1515434869 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 4 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 75000 name: 25 Office Chairs (sample) pipeline_id: 3 pipeline_stage_id: 13 primary_contact_id: 5 priority: None status: Open win_probability: 40 /loss_reasons: get: tags: - 5. Opportunities summary: List Loss Reasons operationId: 5Opportunities_listLossReasons description: >- Loss Reasons identify why a particular Opportunity was lost. The Loss Reasons API allows you to retrieve the list of Loss Reasons associated with your Copper account. | Field | Description | | ------------- | -------------------------------------- | | id (number) | Unique identifier for the Loss Reason. | | name (string) | The name of the Loss Reason. | parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: Loss Reasons headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Thu, 08 Jun 2017 18:44:19 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJWQzMzExMjA0MjY2MGFjNTgwMjQ0MzNhNGJhZDcwMmExBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMS93bGhRUXRNVkZUeENRQjJDdVByUEkvMEx3c2FqZDVJSVBFc2NFOFowQUU9BjsARg%3D%3D--17929806d9ee75df558e2ff85c3fd102d6399da1; domain=prosperworks.com; path=/; expires=Fri, 08-Jun-2018 18:44:19 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 266e66cd-4a51-4704-bc2d-934c1d05a415 X-Runtime: schema: type: string example: '0.079849' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/5OpportunitiesListLossReasonsResponse' examples: Loss Reasons: value: - id: 308806 name: Price - id: 308807 name: Features - id: 308808 name: Competitor /pipelines: get: tags: - 5. Opportunities summary: List Pipelines operationId: 5Opportunities_getPipelinesList description: >- Pipelines define the stages through which Opportunities move as they progress through your sales process. The Pipelines API allows you to retrieve the list of Pipelines associated with your Copper account. | Field | Details | | ------------- | --------------------------------------------- | | id (number) | Unique identifier for the Pipeline. | | name (string) | The name of the Pipeline. | | stages (list) | The list of Pipeline Stages in this Pipelines | parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: Pipelines headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Thu, 08 Jun 2017 18:48:02 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJWQzMzExMjA0MjY2MGFjNTgwMjQ0MzNhNGJhZDcwMmExBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMS93bGhRUXRNVkZUeENRQjJDdVByUEkvMEx3c2FqZDVJSVBFc2NFOFowQUU9BjsARg%3D%3D--17929806d9ee75df558e2ff85c3fd102d6399da1; domain=prosperworks.com; path=/; expires=Fri, 08-Jun-2018 18:48:02 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: d8384d84-0bb4-48e2-9275-361c3e20cc7c X-Runtime: schema: type: string example: '0.109667' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/5OpportunitiesGetPipelinesListResponse' examples: Pipelines: value: - id: 213214 name: Sales stages: - id: 987790 name: Qualified win_probability: 5 - id: 987791 name: Follow-up win_probability: 10 - id: 987792 name: Presentation win_probability: 20 - id: 987793 name: Contract Sent win_probability: 40 - id: 987794 name: Negotiation win_probability: 80 - id: 213215 name: Business Development stages: - id: 987795 name: First Meeting win_probability: 10 - id: 987796 name: Partner Meeting win_probability: 25 - id: 987797 name: Negotiation win_probability: 50 - id: 987798 name: Term Sheet win_probability: 75 /pipeline_stages: get: tags: - 5. Opportunities summary: List Pipeline Stages operationId: 5Opportunities_listPipelineStages description: >- Pipeline Stages define the positions of Opportunities within their Pipelines. The Pipeline Stages API allows you to retrieve the list of Pipeline Stages associated with your Copper account. | Field | Details | | ------------------------ | ---------------------------------------------------------------------------------------------------------------- | | id (number) | Unique identifier for the Pipeline Stage. | | name (string) | The name of the Pipeline Stage. | | pipeline_id (number) | The unique identifier of the Pipeline in which this Pipeline Stage is. | | win_probability (number) | The expected probability of winning an Opportunity in this Pipeline Stage. Valid values are [0-100](inclusive). | parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: Pipeline Stages headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Thu, 08 Jun 2017 18:57:43 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJWQzMzExMjA0MjY2MGFjNTgwMjQ0MzNhNGJhZDcwMmExBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMS93bGhRUXRNVkZUeENRQjJDdVByUEkvMEx3c2FqZDVJSVBFc2NFOFowQUU9BjsARg%3D%3D--17929806d9ee75df558e2ff85c3fd102d6399da1; domain=prosperworks.com; path=/; expires=Fri, 08-Jun-2018 18:57:43 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 2d846340-d387-42d2-a686-8fb82056ba72 X-Runtime: schema: type: string example: '0.109547' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/5OpportunitiesListPipelineStagesResponse' examples: Pipeline Stages: value: - id: 987790 name: Qualified pipeline_id: 213214 win_probability: 5 - id: 987791 name: Follow-up pipeline_id: 213214 win_probability: 10 - id: 987792 name: Presentation pipeline_id: 213214 win_probability: 20 - id: 987793 name: Contract Sent pipeline_id: 213214 win_probability: 40 - id: 987794 name: Negotiation pipeline_id: 213214 win_probability: 80 - id: 987795 name: First Meeting pipeline_id: 213215 win_probability: 10 - id: 987796 name: Partner Meeting pipeline_id: 213215 win_probability: 25 - id: 987797 name: Negotiation pipeline_id: 213215 win_probability: 50 - id: 987798 name: Term Sheet pipeline_id: 213215 win_probability: 75 /pipeline_stages/pipeline/{pipeline_id}: parameters: - name: pipeline_id in: path required: true schema: type: string get: tags: - 5. Opportunities summary: List Stages in a Pipeline operationId: 5Opportunities_listPipelineStages description: List Stages in a Pipeline parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: Stages in a Pipeline headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Thu, 08 Jun 2017 18:58:04 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJWQzMzExMjA0MjY2MGFjNTgwMjQ0MzNhNGJhZDcwMmExBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMS93bGhRUXRNVkZUeENRQjJDdVByUEkvMEx3c2FqZDVJSVBFc2NFOFowQUU9BjsARg%3D%3D--17929806d9ee75df558e2ff85c3fd102d6399da1; domain=prosperworks.com; path=/; expires=Fri, 08-Jun-2018 18:58:04 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 5c41f4a4-0e3d-4136-adb9-2d651daca6ac X-Runtime: schema: type: string example: '0.200747' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: >- #/components/schemas/5OpportunitiesListPipelineStages200Response examples: Stages in a Pipeline: value: - id: 987790 name: Qualified pipeline_id: 213214 win_probability: 5 - id: 987791 name: Follow-up pipeline_id: 213214 win_probability: 10 - id: 987792 name: Presentation pipeline_id: 213214 win_probability: 20 - id: 987793 name: Contract Sent pipeline_id: 213214 win_probability: 40 - id: 987794 name: Negotiation pipeline_id: 213214 win_probability: 80 /projects/{example_project_id}: parameters: - name: example_project_id in: path required: true schema: type: string get: tags: - 6. Projects summary: Fetch a Project by ID operationId: 6Projects_getById description: Fetch a Project by ID parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: Get project headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 06 Jun 2017 01:35:54 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Wed, 06-Jun-2018 01:35:54 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 2a89ea37-1807-4927-b37c-795b724bec4a X-Runtime: schema: type: string example: '0.088536' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/6ProjectsGetByIdResponse' examples: Get project: value: tags: [] assignee_id: null custom_fields: [] date_created: 1483988830 date_modified: 1496712857 details: >- Visit our settings section to discover all the ways you can customize Copper to fit your sales workflow. id: 144296 name: Customize Your New CRM related_resource: id: 9607579 type: company status: Open put: tags: - 6. Projects summary: Update a Project operationId: 6Projects_updateProject description: >- Updates are only applied to fields explicitly specified in the request body. For example, if an update request is made with an empty body, no updates will be made. To remove the value from a field, the request body must specify the target field value as 'null'. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/6ProjectsUpdateProjectRequest' examples: Update a Project: value: details: This is an update responses: '200': description: Update Project headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 06 Jun 2017 19:11:55 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Wed, 06-Jun-2018 19:11:55 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 97177414-7ed4-4e15-a218-9b74f41a33f0 X-Runtime: schema: type: string example: '0.630824' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/6ProjectsUpdateProjectResponse' examples: Update Project: value: tags: [] assignee_id: null custom_fields: [] date_created: 1483988830 date_modified: 1496776314 details: This is an update id: 144296 name: Customize Your New CRM related_resource: id: 9607579 type: company status: Open /projects: post: tags: - 6. Projects summary: Create a New Project operationId: 6Projects_createNewProject description: |- The following fields are required for this request: "name" parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/6ProjectsCreateNewProjectRequest' examples: Create a New Project: value: name: New Demo Project responses: '200': description: New Project headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 06 Jun 2017 01:51:07 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Wed, 06-Jun-2018 01:51:07 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: b9413527-a4fa-4aa4-a392-2bb6de7b21de X-Runtime: schema: type: string example: '0.310020' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/6ProjectsCreateNewProjectResponse' examples: New Project: value: tags: [] assignee_id: null custom_fields: [] date_created: 1496713867 date_modified: 1496713867 details: null id: 208105 name: New Demo Project related_resource: null status: Open /projects/{delete_project_id}: parameters: - name: delete_project_id in: path required: true schema: type: string delete: tags: - 6. Projects summary: Delete a Project operationId: 6Projects_removeProjectRecord description: This request permanently removes a record from your Copper account. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: text/plain: examples: Delete a Project: value: '' schema: description: >- WARNING: Missing schema in media type object. Missing schema has been filled with this AnyType schema. responses: '200': description: Delete Project headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Mon, 05 Jun 2017 22:00:17 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Tue, 05-Jun-2018 22:00:17 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: ff7ea1c8-8eb5-47df-b368-f0623bd70bb3 X-Runtime: schema: type: string example: '0.204549' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/6ProjectsRemoveProjectRecordResponse' examples: Delete Project: value: id: 99999999 is_deleted: true /projects/search: post: tags: - 6. Projects summary: List Projects (Search) operationId: 6Projects_listProjectsSearch description: >- The /search endpoint provides the ability to list records and sort the results by certain parameters. When multiple ciriteria are provided records meeting ALL criteria will be returned (the filtering criteria have an 'AND' relationship). To see examples of search request using the various parameters, click on the `Projects Search` dropdown on the right. Certain fields can be filtered by an empty value, i.e., filter records where the field is not specified. For Projects, these fields are: tags, custom dropdown, custom multi-select fields. For an example of how this works, see `Search Project by Empty Field`. Some fields (e.g. assignee_ids) can also filter for an empty value by specifying -2 as the ID. To search by custom fields, see `Search Entity by Custom Field` under `Custom Fields` folder. To change the number of records returned, change the "page_size" parameter. E.g., specify 200 for a page size of 200 records. | Field | Type | Details | Default | | ------------------------- | --------- | -------------------------------------------------------------------------------------------- | ------- | | page_number | number | The page number (starting with 1) that you would like to view. | 1 | | page_size | number | The number of entries included in a page of results | 20 | | sort_by | string | The field on which to sort the results (see footnote 1). | name | | sort_direction | string | The direction in which to sort the results. Possible values are: asc or desc. | asc | | name | string | Full name of the Opportunity to search for. | none | | assignee_ids | number[] | The ids of Users that Opportunities must be owned by, or -2 for Opportunities with no owner. | none | | status_ids | number[] | An array of Opportunity status IDs. | none | | tags | string[] | Filter Opportunities to those that match at least one of the tags specified. | none | | followed | number | 1: followed, 2: not followed | none | | minimum_created_date | timestamp | The Unix timestamp of the earliest date Opportunities are created. | none | | maximum_created_date | timestamp | The Unix timestamp of the latest date Opportunities are created. | none | | minimum_modified_date | timestamp | The Unix timestamp of the earliest date Opportunities are modified. | none | | maximum_modified_date | timestamp | The Unix timestamp of the latest date Opportunities are modified. | none | Foonotes: 1. Possible fields are: name, assigned_to, related_to, status, date_modified, date_created. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/6ProjectsListProjectsSearchRequest' examples: List Projects (Search): value: custom_fields: - custom_field_definition_id: 12 option: ANY value: - 8 page_size: 25 sort_by: name responses: '200': description: >- Projects Search / Search Projects by Tags / Search Projects by Assignee Ids / Search Projects by Statuses / Search Projects by Custom Date Field / List Projects in Groups of 200 / Search Projects by Custom Multi-Select Dropdown Set to Empty / Search Projects by Custom Multi-Select Dropdown headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: keep-alive Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 23 Jan 2018 23:42:23 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: nginx/1.12.2 Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTAyNmI5MGY4OTg5MDQ2NDBkNWQ1ZGUxNDU4MmQyMWJmBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMUlONTNKQUU3bGczS2pmV24vUzE0S3I5S3YxQUJhUzFuelRTQm9NcGF2OTQ9BjsARg%3D%3D--b2a6d835c09ab10305dde74393f501d2e36bf8e3; domain=lvh.me; path=/; expires=Wed, 23-Jan-2019 23:42:23 GMT; HttpOnly Status: schema: type: string example: 200 OK Transfer-Encoding: schema: type: string example: chunked Vary: schema: type: string example: Accept-Encoding X-Frame-Options: schema: type: string example: SAMEORIGIN X-PW-TOTAL: schema: type: string example: '1' X-Rack-CORS: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 445979dfae8f6537dc26def94c781051 X-Runtime: schema: type: string example: '0.844811' X-UA-Compatible: schema: type: string example: IE=Edge content: application/json: schema: $ref: '#/components/schemas/6ProjectsListProjectsSearchResponse' examples: List Projects in Groups of 200: value: - tags: - tag1 assignee_id: 2 custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1515434872 date_modified: 1516819000 details: >- Visit our settings section to discover all the ways you can customize Copper to fit your sales workflow. id: 1 name: Customize Your New CRM related_resource: id: 2 type: company status: Open - tags: [] assignee_id: 2 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1516751006 date_modified: 1516751006 details: null id: 2 name: Test Project related_resource: null status: Open Projects Search: value: - tags: [] address: city: San Francisco country: null postal_code: '94105' state: CA street: 123 Main St assignee_id: null contact_type_id: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1496707930 date_modified: 1496707932 details: This is a demo company email_domain: democompany.com id: 13358412 interaction_count: 0 name: Demo Company phone_numbers: - category: work number: 415-123-45678 socials: [] websites: - category: work url: http://democompany.com - tags: [] address: city: Scranton country: '' postal_code: '18501' state: PA street: 213 West Main Street assignee_id: null contact_type_id: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1483988828 date_modified: 1496710807 details: This is an update email_domain: dundermifflin.com id: 9607580 interaction_count: 2 name: Dunder Mifflin (sample) phone_numbers: - category: work number: '4153554776' socials: [] websites: - category: work url: http://www.dundermifflin.com/index.shtml - category: work url: >- https://www.nbcstore.com/shop-by-show/the-office.html?shop_by_theme=7 - category: work url: http://dundermifflin.com - tags: [] address: null assignee_id: null contact_type_id: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1496713616 date_modified: 1496713616 details: null email_domain: null id: 13362547 interaction_count: 0 name: New Demo Opportunity phone_numbers: [] socials: [] websites: [] - tags: [] address: null assignee_id: null contact_type_id: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1496713797 date_modified: 1496713797 details: null email_domain: null id: 13362760 interaction_count: 0 name: New Demo Project phone_numbers: [] socials: [] websites: [] - tags: [] address: null assignee_id: 137658 contact_type_id: 451490 custom_fields: - custom_field_definition_id: 100764 value: Text fields are 255 chars or less! - custom_field_definition_id: 103481 value: Text area fields can have long text content date_created: 1496694264 date_modified: 1496713841 details: null email_domain: noemail.com id: 13349319 interaction_count: 0 name: Noemail phone_numbers: [] socials: [] websites: [] - tags: [] address: city: San Francisco country: '' postal_code: '94105' state: CA street: 221 Main Street Suite 1350 assignee_id: null contact_type_id: 451493 custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1483988828 date_modified: 1489018922 details: >- Overview: ProsperWorks is the world's first zero input CRM. Designed specifically for Google Apps, ProsperWorks helps companies sell more faster by identifying, organizing and tracking sales opportunities right in Gmail, Calendar and Google Drive. By removing the need for data entry, salespeople can focus on developing business and managers can finally have accurate forecasting with real time activity tracking. ProsperWorks was founded by Jon Lee, Kelly Cheng and Andrew Hu with the commitment to empower small business sales and marketing. Jon was Founder/CEO of three big data companies that solved optimization problems in advertising, gaming and photo sharing. Each company realized successful exits. The team also includes the leaders in engineering and product from Facebook Mobile, BaseCRM and Salesforce. ProsperWorks has raised $10 million in funding from True Ventures, Bloomberg Beta, Crunchfund and other high-profile angel investors. ProsperWorks is based in San Francisco, CA. Approx. Number of Employees: 30 Founded: 2011 Keywords: Automotive, CRM, Finance, Google, Google Apps, Leadership, Management, Podcasting, SAAS, Sales, Small Business email_domain: copper.com id: 9607579 interaction_count: 0 name: Copper phone_numbers: - category: work number: '4153554776' socials: - category: linkedin url: https://www.linkedin.com/company/copper-inc- - category: twitter url: https://twitter.com/Copper - category: facebook url: https://www.facebook.com/Copper - category: klout url: http://klout.com/Copper - category: other url: https://angel.co/copper - category: other url: https://plus.google.com/u/0/103594665195397142807 - category: other url: http://www.crunchbase.com/organization/copper websites: - category: work url: www.copper.com - category: work url: https://www.copper.com - tags: [] address: city: Philadelphia country: '' postal_code: '19135' state: PA street: 543 Washington Ave assignee_id: null contact_type_id: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1483988828 date_modified: 1489018922 details: null email_domain: null id: 9607581 interaction_count: 0 name: Sabre Inc (sample) phone_numbers: [] socials: [] websites: [] Search Projects by Assignee Ids: value: - tags: - tag1 assignee_id: 2 custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1515434872 date_modified: 1516747365 details: >- Visit our settings section to discover all the ways you can customize Copper to fit your sales workflow. id: 1 name: Customize Your New CRM related_resource: id: 2 type: company status: Open Search Projects by Custom Date Field: value: - tags: - tag1 assignee_id: 2 custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1515434872 date_modified: 1516747365 details: >- Visit our settings section to discover all the ways you can customize Copper to fit your sales workflow. id: 1 name: Customize Your New CRM related_resource: id: 2 type: company status: Open Search Projects by Custom Multi-Select Dropdown: value: - tags: - tag1 assignee_id: 2 custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1515434872 date_modified: 1516747365 details: >- Visit our settings section to discover all the ways you can customize Copper to fit your sales workflow. id: 1 name: Customize Your New CRM related_resource: id: 2 type: company status: Open Search Projects by Custom Multi-Select Dropdown Set to Empty: value: - tags: [] assignee_id: 2 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1516751006 date_modified: 1516751006 details: null id: 2 name: Test Project related_resource: null status: Open Search Projects by Statuses: value: - tags: - tag1 assignee_id: 2 custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1515434872 date_modified: 1516747365 details: >- Visit our settings section to discover all the ways you can customize Copper to fit your sales workflow. id: 1 name: Customize Your New CRM related_resource: id: 2 type: company status: Open Search Projects by Tags: value: - tags: - tag1 assignee_id: 2 custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1515434872 date_modified: 1516747365 details: >- Visit our settings section to discover all the ways you can customize Copper to fit your sales workflow. id: 1 name: Customize Your New CRM related_resource: id: 2 type: company status: Open /tasks/{example_task_id}: parameters: - name: example_task_id in: path required: true schema: type: string get: tags: - 7. Tasks summary: Fetch a Task by ID operationId: 7Tasks_getTaskById description: Fetch a Task by ID parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: Get Task headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 06 Jun 2017 01:35:40 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Wed, 06-Jun-2018 01:35:40 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 1b0bcea2-9118-4d91-b63c-be02daa153ce X-Runtime: schema: type: string example: '0.090823' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/7TasksGetTaskByIdResponse' examples: Get Task: value: tags: [] assignee_id: 137658 completed_date: null custom_fields: [] date_created: 1496712856 date_modified: 1496712857 details: null due_date: 1496799000 id: 3716920 name: My First Task priority: None related_resource: id: 144296 type: project reminder_date: null status: Open put: tags: - 7. Tasks summary: Update a Task operationId: 7Tasks_updateTaskRecord description: >- Updates are only applied to fields explicitly specified in the request body. For example, if an update request is made with an empty body, no updates will be made. To remove the value from a field, the request body must specify the target field value as 'null'. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/7TasksUpdateTaskRecordRequest' examples: Update a Task: value: details: This is an update responses: '200': description: Update Task headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 06 Jun 2017 19:12:49 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Wed, 06-Jun-2018 19:12:49 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 23145eb9-56d1-4d16-8bb4-a223d03535f8 X-Runtime: schema: type: string example: '0.370148' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/7TasksUpdateTaskRecordResponse' examples: Update Task: value: tags: [] assignee_id: 137658 completed_date: null custom_fields: [] date_created: 1496712856 date_modified: 1496776369 details: This is an update due_date: 1496799000 id: 3716920 name: My First Task priority: None related_resource: id: 144296 type: project reminder_date: null status: Open /tasks: post: tags: - 7. Tasks summary: Create a New Task operationId: 7Tasks_createNewTask description: Create a New Task parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/7TasksCreateNewTaskRequest' examples: Create a New Task: value: name: Demo Task responses: '200': description: Create Task headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 06 Jun 2017 17:59:45 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Wed, 06-Jun-2018 17:59:45 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 4e55995f-c497-4b3a-90b0-ac0d7e00885c X-Runtime: schema: type: string example: '0.384387' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/7TasksCreateNewTaskResponse' examples: Create Task: value: tags: [] assignee_id: 137658 completed_date: null custom_fields: [] date_created: 1496771985 date_modified: 1496771985 details: null due_date: null id: 3726701 name: Demo Task priority: None related_resource: id: null type: null reminder_date: null status: Open /tasks/{delete_task_id}: parameters: - name: delete_task_id in: path required: true schema: type: string delete: tags: - 7. Tasks summary: Delete a Task operationId: 7Tasks_removeTaskRecord description: This request permanently removes a record from your Copper account. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: text/plain: examples: Delete a Task: value: '' schema: description: >- WARNING: Missing schema in media type object. Missing schema has been filled with this AnyType schema. responses: '200': description: Delete Task headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Mon, 05 Jun 2017 22:00:17 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Tue, 05-Jun-2018 22:00:17 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: ff7ea1c8-8eb5-47df-b368-f0623bd70bb3 X-Runtime: schema: type: string example: '0.204549' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/7TasksRemoveTaskRecordResponse' examples: Delete Task: value: id: 99999999 is_deleted: true /tasks/search: post: tags: - 7. Tasks summary: List Tasks (Search) operationId: 7Tasks_listTasksSearch description: >- The /search endpoint provides the ability to list people and sort the results by certain parameters. When multiple ciriteria are provided records meeting ALL criteria will be returned (the filtering criteria have an 'AND' relationship). To see examples of search request using the various parameters, click on the `Tasks Search` dropdown on the right. Certain fields can be filtered by an empty value, i.e., filter records where the field is not specified. For Tasks, these fields are: company, opportunity, city, state, postal_code, tags, custom dropdown, custom multi-select fields. Some fields (e.g. assignee_ids) can also filter for an empty value by specifying -2 as the ID. To search by custom fields, see `Search Entity by Custom Field` under `Custom Fields` folder. To change the number of records returned, change the "page_size" parameter. E.g., specify 200 for a page size of 200 records. | Field | Type | Details | Default | | ------------------------- | --------- | ------------------------------------------------------------------------------ | ---------- | | page_number | number | The page number (starting with 1) that you would like to view. | 1 | | page_size | number | The number of entries included in a page of results | 20 | | sort_by | string | The field on which to sort the results (see footnote 1). | due_date | | sort_direction | string | The direction in which to sort the results. Possible values are: asc or desc. | asc | | assignee_ids | number[] | The ids of Users that Tasks must be owned by, or -2 for Tasks with no owner. | none | | opportunity_ids | number[] | An array of Opportunity IDs (see footnote 2). | none | | project_ids | number[] | The ids of Projects that Tasks belong to, or -2 for Tasks with no project. | none | | statuses | string[] | Filter Tasks to statuses specified ("Open", "Completed"). | none | | tags | string[] | Filter Tasks to those that match at least one of the tags specified. | none | | followed | number | 1: followed, 2: not followed | none | | minimum_due_date | timestamp | The minimum due date Tasks must have. | none | | maximum_due_date | timestamp | The maximum due date Tasks must have. | none | | minimum_created_date | timestamp | The Unix timestamp of the earliest date Tasks are created. | none | | maximum_created_date | timestamp | The Unix timestamp of the latest date Tasks are created. | none | | minimum_modified_date | timestamp | The minimum modified date Tasks must have. | none | | maximum_modified_date | timestamp | The maximum modified date Tasks must have. | none | Footnote: 1. Possible fields are: name, assigned_to, related_to, status, priority, due_date, reminder_date, completed_date, date_created, date_modified. 2. See `List Opportunities (Search)` under 5. Opportunities folder. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/7TasksListTasksSearchRequest' examples: List Tasks (Search): value: page_size: 25 sort_by: name statuses: - Completed responses: '200': description: >- Search Tasks by Multi-Select Dropdown Set to Empty / Search Tasks by Project Ids / Search Tasks by Assignee Ids / Search Tasks by Due Date / Search Tasks by Followed / Search Tasks by Opportunity Ids / Search Tasks by Multi-Select Dropdown / Search Tasks by Tags / List Tasks in Groups of 200 / Search Tasks by Custom Date Field / Tasks Search / Search Tasks by Statuses headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: keep-alive Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Wed, 24 Jan 2018 20:03:10 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: nginx/1.12.2 Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTAyNmI5MGY4OTg5MDQ2NDBkNWQ1ZGUxNDU4MmQyMWJmBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMUlONTNKQUU3bGczS2pmV24vUzE0S3I5S3YxQUJhUzFuelRTQm9NcGF2OTQ9BjsARg%3D%3D--b2a6d835c09ab10305dde74393f501d2e36bf8e3; domain=lvh.me; path=/; expires=Thu, 24-Jan-2019 20:03:10 GMT; HttpOnly Status: schema: type: string example: 200 OK Transfer-Encoding: schema: type: string example: chunked Vary: schema: type: string example: Accept-Encoding X-Frame-Options: schema: type: string example: SAMEORIGIN X-PW-TOTAL: schema: type: string example: '1' X-Rack-CORS: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 8447289c4f7b5200032ab69a108c4feb X-Runtime: schema: type: string example: '0.783649' X-UA-Compatible: schema: type: string example: IE=Edge content: application/json: schema: $ref: '#/components/schemas/7TasksListTasksSearchResponse' examples: List Tasks in Groups of 200: value: - tags: [] assignee_id: null completed_date: null custom_activity_type_id: 6 custom_fields: - custom_field_definition_id: 6 value: null - custom_field_definition_id: 12 value: - 9 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1515434871 date_modified: 1516824438 details: >- Visit the Google Play store or the Apple App store to download the ProsperWorks Android or iPhone app. due_date: 1516813200 id: 1 name: Download ProsperWorks Mobile App priority: None related_resource: id: 2 type: company reminder_date: null status: Open - tags: [] assignee_id: null completed_date: null custom_activity_type_id: 6 custom_fields: - custom_field_definition_id: 6 value: null - custom_field_definition_id: 12 value: - 9 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1515434871 date_modified: 1516824426 details: null due_date: 1515776400 id: 3 name: Follow up Call (sample) priority: None related_resource: id: 5 type: person reminder_date: null status: Open - tags: [] assignee_id: null completed_date: 1516822940 custom_activity_type_id: 6 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434871 date_modified: 1516822940 details: null due_date: 1515517200 id: 2 name: Follow up on Price Quote (sample) priority: None related_resource: id: 4 type: opportunity reminder_date: null status: Completed - tags: - tag1 assignee_id: 2 completed_date: null custom_activity_type_id: 6 custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1516818999 date_modified: 1516819000 details: null due_date: 1516905000 id: 6 name: New CRM Task priority: High related_resource: id: 1 type: project reminder_date: null status: Open Search Tasks by Assignee Ids: value: - tags: - tag1 assignee_id: 2 completed_date: null custom_activity_type_id: 6 custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1516818999 date_modified: 1516819000 details: null due_date: 1516905000 id: 6 name: New CRM Task priority: High related_resource: id: 1 type: project reminder_date: null status: Open Search Tasks by Custom Date Field: value: - tags: - tag1 assignee_id: 2 completed_date: null custom_activity_type_id: 6 custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1516818999 date_modified: 1516819000 details: null due_date: 1516905000 id: 6 name: New CRM Task priority: High related_resource: id: 1 type: project reminder_date: null status: Open Search Tasks by Due Date: value: - tags: [] assignee_id: null completed_date: null custom_activity_type_id: 6 custom_fields: - custom_field_definition_id: 6 value: null - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1515434871 date_modified: 1516819079 details: null due_date: 1515776400 id: 3 name: Follow up Call (sample) priority: None related_resource: id: 5 type: person reminder_date: null status: Open Search Tasks by Followed: value: - tags: - tag1 assignee_id: 2 completed_date: null custom_activity_type_id: 6 custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1516818999 date_modified: 1516819000 details: null due_date: 1516905000 id: 6 name: New CRM Task priority: High related_resource: id: 1 type: project reminder_date: null status: Open Search Tasks by Multi-Select Dropdown: value: - tags: - tag1 assignee_id: 2 completed_date: null custom_activity_type_id: 6 custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1516818999 date_modified: 1516819000 details: null due_date: 1516905000 id: 6 name: New CRM Task priority: High related_resource: id: 1 type: project reminder_date: null status: Open Search Tasks by Multi-Select Dropdown Set to Empty: value: - tags: [] assignee_id: null completed_date: 1516822940 custom_activity_type_id: 6 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434871 date_modified: 1516822940 details: null due_date: 1515517200 id: 2 name: Follow up on Price Quote (sample) priority: None related_resource: id: 4 type: opportunity reminder_date: null status: Completed Search Tasks by Opportunity Ids: value: - tags: [] assignee_id: null completed_date: null custom_activity_type_id: 6 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434871 date_modified: 1516820005 details: null due_date: 1515517200 id: 2 name: Follow up on Price Quote (sample) priority: None related_resource: id: 4 type: opportunity reminder_date: null status: Open Search Tasks by Project Ids: value: - tags: - tag1 assignee_id: 2 completed_date: null custom_activity_type_id: 6 custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1516818999 date_modified: 1516819000 details: null due_date: 1516905000 id: 6 name: New CRM Task priority: High related_resource: id: 1 type: project reminder_date: null status: Open Search Tasks by Statuses: value: - tags: [] assignee_id: null completed_date: 1516822940 custom_activity_type_id: 6 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434871 date_modified: 1516822940 details: null due_date: 1515517200 id: 2 name: Follow up on Price Quote (sample) priority: None related_resource: id: 4 type: opportunity reminder_date: null status: Completed Search Tasks by Tags: value: - tags: - tag1 assignee_id: 2 completed_date: null custom_activity_type_id: 6 custom_fields: - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null - custom_field_definition_id: 5 value: null date_created: 1516818999 date_modified: 1516819000 details: null due_date: 1516905000 id: 6 name: New CRM Task priority: High related_resource: id: 1 type: project reminder_date: null status: Open Tasks Search: value: - tags: [] assignee_id: 137658 completed_date: null custom_fields: [] date_created: 1496771985 date_modified: 1496771985 details: null due_date: null id: 3726701 name: Demo Task priority: None related_resource: id: null type: null reminder_date: null status: Open - tags: [] assignee_id: null completed_date: null custom_fields: [] date_created: 1483988829 date_modified: 1483989349 details: >- Visit the Google Play store or the Apple App store to download the ProsperWorks Android or iPhone app. due_date: null id: 2277769 name: Download ProsperWorks Mobile App priority: None related_resource: id: 9607579 type: company reminder_date: null status: Open - tags: [] assignee_id: null completed_date: null custom_fields: [] date_created: 1483988829 date_modified: 1489018922 details: null due_date: 1483894800 id: 2277771 name: Follow up Call (sample) priority: None related_resource: id: null type: null reminder_date: null status: Open - tags: [] assignee_id: null completed_date: null custom_fields: [] date_created: 1483988829 date_modified: 1483988829 details: null due_date: 1484067600 id: 2277770 name: Follow up on Price Quote (sample) priority: None related_resource: id: null type: null reminder_date: null status: Open - tags: [] assignee_id: 137658 completed_date: null custom_fields: [] date_created: 1496712856 date_modified: 1496776369 details: This is an update due_date: 1496799000 id: 3716920 name: My First Task priority: None related_resource: id: 144296 type: project reminder_date: null status: Open /activities/{example_activity_id}: parameters: - name: example_activity_id in: path required: true schema: type: string get: tags: - 8. Activities summary: Fetch an Activity by ID operationId: 8Activities_getActivityById description: Fetch an Activity by ID parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: Get Activity headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 06 Jun 2017 01:35:27 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Wed, 06-Jun-2018 01:35:27 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 75a38791-763b-4071-b831-528e644f5257 X-Runtime: schema: type: string example: '0.093983' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/8ActivitiesGetActivityByIdResponse' examples: Get Activity: value: activity_date: 1496710783 date_created: 1496710787 date_modified: 1496710783 details: Demo phone call id: 3061844454 new_value: null old_value: null parent: id: 9607580 type: company type: category: user id: 190711 user_id: 137658 /activities: post: tags: - 8. Activities summary: Create a New Activity operationId: 8Activities_createNewActivity description: Create a New Activity parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/8ActivitiesCreateNewActivityRequest' examples: Create a New Activity: value: details: This is the description of this note parent: id: 27140359 type: person type: category: user id: 0 responses: '200': description: Create New Note headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 06 Jun 2017 18:05:55 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Wed, 06-Jun-2018 18:05:55 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: d06b1802-88cd-46ee-8b7d-d5dc9300d9be X-Runtime: schema: type: string example: '0.213978' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/8ActivitiesCreateNewActivityResponse' examples: Create New Note: value: activity_date: 1496772355 date_created: 1496772355 date_modified: 1496772355 details: This is the description of this note id: 3064242278 new_value: null old_value: null parent: id: 27140359 type: person type: category: user id: 0 user_id: 137658 /activities/{delete_activity_id}: parameters: - name: delete_activity_id in: path required: true schema: type: string delete: tags: - 8. Activities summary: Delete an Activity operationId: 8Activities_removeActivityRecord description: This request permanently removes a record from your Copper account. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: text/plain: examples: Delete an Activity: value: '' schema: description: >- WARNING: Missing schema in media type object. Missing schema has been filled with this AnyType schema. responses: '200': description: Delete Activity headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Mon, 05 Jun 2017 22:00:17 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Tue, 05-Jun-2018 22:00:17 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: ff7ea1c8-8eb5-47df-b368-f0623bd70bb3 X-Runtime: schema: type: string example: '0.204549' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/8ActivitiesRemoveActivityRecordResponse' examples: Delete Activity: value: id: 99999999 is_deleted: true /activities/search: post: tags: - 8. Activities summary: List Activities (Search) operationId: 8Activities_listSearch description: >- The /search endpoint provides the ability to list records and sort the results by certain parameters. When multiple ciriteria are provided records meeting ALL criteria will be returned (the filtering criteria have an 'AND' relationship). To see examples of search request using the various parameters, click on the `Search Activities` dropdown on the right. | Field | Type | Details | Default | | --------------------- | --------------- | ---------------------------------------------------------------------------------------------------------------- | ------- | | parent | hash | A hash describing the resource to which activities must belong (footnote 1). | | | activity_types | activity_type[] | The activity types to filter results on (footnote 1). | none | | page_number | number | The page number (starting with 1) that you would like to view. | 1 | | page_size | number | The number of entries included in a page of results | 20 | | minimum_activity_date | number | The Unix timestamp of the earliest activity date. | none | | maximum_activity_date | number | The Unix timestamp of the latest activity date. | none | | full_result | boolean | (Optional) If set to true, search performance improves but duplicate activity logs may be returned (footnote 3). | false | Footnotes: 1. Parent is specified by: {"id": parent_id, "type": parent_type}. "parent_type" can be "lead", "person", "company", "opportunity", "project", "task". 2. Activity types is specified by: {"id": activity_type_id, "category": category }. "activity_type_id" and "category" can be retrieved from `List Activity Types` under `Other Resources` folder. 3. If the List Activities Search endpoint is timing out, a flag `full_result=true` can be added. One can expect to see multiple entries returned for the same activity if an email was sent to multiple users. In order to use this flag, user must have admin capabilities. Otherwise, the flag is ignored. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/8ActivitiesListSearchRequest' examples: List Activities (Search): value: page_size: 25 responses: '200': description: Search Activities by Date / Search Activities headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 06 Jun 2017 21:42:45 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Wed, 06-Jun-2018 21:42:45 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: baab3d97-53e1-4d7b-8a21-b1dc87493214 X-Runtime: schema: type: string example: '0.217050' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/8ActivitiesListSearchResponse' examples: Search Activities: value: - activity_date: 1496772355 date_created: 1496772355 date_modified: 1496772355 details: This is the description of this note id: 3064242278 new_value: null old_value: null parent: id: 27140359 type: person type: category: user id: 0 user_id: 137658 - activity_date: 1496710783 date_created: 1496710787 date_modified: 1496710783 details: This is an update id: 3061844454 new_value: null old_value: null parent: id: 9607580 type: company type: category: user id: 190711 user_id: 137658 - activity_date: 1496703593 date_created: 1496703597 date_modified: 1496703593 details: Demo call id: 3061588719 new_value: null old_value: null parent: id: 27140442 type: person type: category: user id: 190711 user_id: 137658 - activity_date: 1496327400 date_created: 1496710806 date_modified: 1496327400 details: Sales discussioin id: 3061845284 new_value: null old_value: null parent: id: 9607580 type: company type: category: user id: 190712 user_id: 137658 - activity_date: 1489019921 date_created: 1489019921 date_modified: 1489019921 details: null id: 2826555341 new_value: null old_value: null parent: id: 8894157 type: lead type: category: system id: 1 user_id: 137658 - activity_date: 1489019860 date_created: 1489019860 date_modified: 1489019860 details: null id: 2826550854 new_value: null old_value: null parent: id: 8894157 type: lead type: category: system id: 1 user_id: 137658 - activity_date: 1489019856 date_created: 1489019856 date_modified: 1489019856 details: null id: 2826550639 new_value: null old_value: null parent: id: 8894157 type: lead type: category: system id: 1 user_id: 137658 - activity_date: 1484706603 date_created: 1484706614 date_modified: 1484706603 details: Talked with assistant, will be back tomorrow id: 2693189358 new_value: null old_value: null parent: id: 23136297 type: person type: category: user id: 194674 user_id: 137658 - activity_date: 1484706298 date_created: 1484706292 date_modified: 1484706292 details: Discussed the new product feature id: 2693184664 new_value: null old_value: null parent: id: 23136297 type: person type: category: user id: 190711 user_id: 137658 - activity_date: 1484096559 date_created: 1484096557 date_modified: 1484096557 details: ertyfsxcvplkytet id: 2677929084 new_value: null old_value: null parent: id: 23136298 type: person type: category: user id: 190711 user_id: 137658 Search Activities by Date: value: - activity_date: 1516302332 date_created: 1516302332 date_modified: 1516302332 details: null id: 203 new_value: null old_value: null parent: id: 4 type: person type: category: system id: 1 user_id: 2 /activity_types: get: tags: - 8. Activities summary: List Activity Types operationId: 8Activities_listActivityTypes description: >- Activity Types identify the types of Activities that occur in Copper. The Activity Types Developer API allows you to retrieve the list of Activity Types associated with your Copper account. There are two categories of Activity Type. Activity Types with category "user" describe user-entered Activities. By default, Copper has three user-entered activity types: Notes, Phone Calls, and Meetings. Notes have a hard-coded ID of 0. Phone Calls and Meetings are assigned IDs when your Copper account is created. Users may also create Custom Activity Types through the Settings page. These will be assigned IDs when they are created. Custom Activity Types that have been removed from the list in the Settings page are not deleted from Copper, because they are necessary to correctly handle Activities of those types. These Activity Types are visible through the Developer API for Activity Types, and can be used for filtering Activity searches, but cannot be used to create new Activities. Activity Types with category "system" describe system-generated Activities. There are currently two system activities: "Property Changed" and "Pipeline Stage Changed". They have hard-coded IDs of 1 and 3 respectively. | Field | Type | Details | | -------------------- | ------- | ------------------------------------------------------------------------------------------------------------------- | | id | number | The id of the Activity Type. | | category | string | The category of the Activity Type. Valid categories: user, system. | | name | string | The name of the Activity Type. | | is_disabled | boolean | For Custom Activity Types, whether or not the Activity Type is disabled. | | count_as_interaction | boolean | For Activity Types of category "user", whether or not Activities of this type are counted toward interactions data. | When supplied as parameters for Activity creation or search, Activity Type objects need only specify the "category" and "id" fields. Any other values provided will be ignored. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: List Activity Types headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 06 Jun 2017 18:03:44 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Wed, 06-Jun-2018 18:03:44 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 5962a792-6137-48d8-a492-62a987759268 X-Runtime: schema: type: string example: '0.316149' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/8ActivitiesListActivityTypesResponse' examples: List Activity Types: value: system: - category: system count_as_interaction: false id: 1 is_disabled: false name: Property Changed - category: system count_as_interaction: false id: 3 is_disabled: false name: Pipeline Stage Changed user: - category: user count_as_interaction: false id: 0 is_disabled: false name: Note - category: user count_as_interaction: true id: 190711 is_disabled: false name: Phone Call - category: user count_as_interaction: true id: 190712 is_disabled: false name: Meeting - category: user count_as_interaction: true id: 191400 is_disabled: false name: Demo call - category: user count_as_interaction: true id: 194674 is_disabled: false name: Call - no connect /custom_field_definitions: get: tags: - Custom Fields - General summary: List Custom Field Definitions operationId: CustomFields_listDefinitions description: >- Custom Field Definitions specify account specific fields not included as part of the standard resource fields and allows Copper to be customized to your specific workflow. The Custom Field Definitions API allows you to retrieve the list of Custom Field Definitions associated with your Copper account. | Field | Type | Details | | --------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | number | Unique identifier for the custom field definition. | | name | string | Label for the custom field definition | | data_type | string enum | The type of data that should be stored within this custom field. Possible values are: String, Text, Dropdown, Date, Checkbox, Float, URL, Percentage, Currency, Connect | | currency | string enum | The currency used for this custom field definition. Valid only when the data type is Currency. | | options | options array | A list of possible dropdown options. Valid only when the data type is Dropdown. | parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: Custom Field Definitions headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Thu, 08 Jun 2017 18:34:43 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJWQzMzExMjA0MjY2MGFjNTgwMjQ0MzNhNGJhZDcwMmExBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMS93bGhRUXRNVkZUeENRQjJDdVByUEkvMEx3c2FqZDVJSVBFc2NFOFowQUU9BjsARg%3D%3D--17929806d9ee75df558e2ff85c3fd102d6399da1; domain=prosperworks.com; path=/; expires=Fri, 08-Jun-2018 18:34:43 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: e81616af-4513-40bd-9354-930b3e8c2cf8 X-Runtime: schema: type: string example: '0.071234' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/CustomFieldsListDefinitionsResponse' examples: Custom Field Definitions: value: - available_on: - company - opportunity - lead - person data_type: String id: 100764 name: A Text Field - available_on: - lead - company - opportunity - person data_type: Text id: 103481 name: A Text Area Field - available_on: - opportunity - project data_type: Dropdown id: 126240 name: Color option options: - id: 167776 name: Yellow rank: 4 - id: 167775 name: Orange rank: 3 - id: 167774 name: Blue rank: 2 - id: 167773 name: Green rank: 1 - id: 167772 name: Red rank: 0 post: tags: - Custom Fields - General summary: Create a new custom field definition operationId: CustomFields_createFieldDefinition description: >- | Field | Type | Details | Default | | --------------------- | ------------- | ----------------------- | ---------------------- | | name* | string | Name of the Custom Field Definition | | | data_type* | string | One of the following strings: "Checkbox", "Currency", “Date", "Dropdown", "Float", "MultiSelect", "Percentage", “String", "Text", "URL" | | | available_on | string array | List of strings containing one or more of the following: “lead”, “person”, “opportunity”, “company”, "project", "task" | | | options | integer array | Array of options for Dropdown and MultiSelect fields. A minimum of one option is required for Dropdown and a minimum of 2 options is required for MultiSelect | | | currency | string | 3-letter country code (e.g., "USD", "CAD") | | |\* indicates a required field| | | parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomFieldsCreateFieldDefinitionRequest' examples: Create a new custom field definition: value: available_on: - lead - person data_type: String name: A String responses: '200': description: >- Create a Dropdown Custom Field / Create a Currency Custom Field / Create a String Custom Field headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: keep-alive Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Wed, 21 Nov 2018 19:51:22 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: nginx/1.15.5 Set-Cookie: schema: type: string example: >- _ALI_session_v2=eyJzZXNzaW9uX2lkIjoiMzQ0NWRmMDAxZjhkMDUyNjY4ZGQ0ZWFjZGI0YWU0OWEiLCJ3YXJkZW4udXNlci51c2VyLmtleSI6W1sxXSwiJDJhJDEwJGNWSERqRmJTTXoyS2ZqV3JJZmxQRS4iXSwid2FyZGVuLnVzZXIudXNlci5zZXNzaW9uIjp7Imxhc3RfcmVxdWVzdF9hdCI6MTU0Mjc1NjMwOX19--a27335fb04df5f063cfbf3ba1f7ae43395bca86a; domain=lvh.me; path=/; expires=Thu, 21 Nov 2019 19:51:22 -0000; HttpOnly Strict-Transport-Security: schema: type: string example: max-age=31536000; includeSubDomains Transfer-Encoding: schema: type: string example: chunked Vary: schema: type: string example: Accept-Encoding, Origin X-Content-Type-Options: schema: type: string example: nosniff X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-CORS: schema: type: string example: miss; no-origin X-Request-Id: schema: type: string example: 82f06097-9531-46d8-8467-5f498ce81b7f X-Runtime: schema: type: string example: '0.293330' X-XSS-Protection: schema: type: string example: 1; mode=block content: application/json: schema: $ref: '#/components/schemas/CustomFieldsCreateFieldDefinitionResponse' examples: Create a Currency Custom Field: value: available_on: - lead - person canonical_name: null currency: CAD data_type: Currency id: 6 name: My Currency Create a Dropdown Custom Field: value: available_on: - lead - person - company - project - task canonical_name: null data_type: Dropdown id: 5 name: A Dropdown options: - id: 5 name: Option1 rank: 0 - id: 6 name: Option2 rank: 1 Create a String Custom Field: value: available_on: - lead - person canonical_name: null data_type: String id: 7 name: A String /custom_field_definitions/{custom_field_definition_id}: parameters: - name: custom_field_definition_id in: path required: true schema: type: string get: tags: - Custom Fields - General summary: Fetch a Custom Field Definition operationId: CustomFields_getDefinition description: Fetch a Custom Field Definition parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: Custom Field Definitioin headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Thu, 08 Jun 2017 18:34:54 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJWQzMzExMjA0MjY2MGFjNTgwMjQ0MzNhNGJhZDcwMmExBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMS93bGhRUXRNVkZUeENRQjJDdVByUEkvMEx3c2FqZDVJSVBFc2NFOFowQUU9BjsARg%3D%3D--17929806d9ee75df558e2ff85c3fd102d6399da1; domain=prosperworks.com; path=/; expires=Fri, 08-Jun-2018 18:34:54 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: ce02baa2-f119-4c7b-a8df-c30a1fd39570 X-Runtime: schema: type: string example: '0.093801' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/CustomFieldsGetDefinitionResponse' examples: Custom Field Definitioin: value: available_on: - opportunity - project data_type: Dropdown id: 126240 name: Color option options: - id: 167776 name: Yellow rank: 4 - id: 167775 name: Orange rank: 3 - id: 167774 name: Blue rank: 2 - id: 167773 name: Green rank: 1 - id: 167772 name: Red rank: 0 put: tags: - Custom Fields - General summary: Update an existing custom field definition operationId: CustomFields_updateExistingDefinition description: >- | Field | Type | Details | Default | | --------------------- | ------------- | ----------------------- | ---------------------- | | name* | string | Name of the Custom Field Definition | | | data_type* | string | One of the following strings: "Checkbox", "Currency", “Date", "Dropdown", "Float", "MultiSelect", "Percentage", “String", "Text", "URL" | | | available_on | string array | List of strings containing one or more of the following: “lead”, “person”, “opportunity”, “company”, "project", "task" | | | options | integer array | Array of options for Dropdown and MultiSelect fields. A minimum of one option is required for Dropdown and a minimum of 2 options is required for MultiSelect | | | currency | string | 3-letter country code (e.g., "USD", "CAD") | | |\* indicates a required field| | | parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomFieldsUpdateExistingDefinitionRequest' examples: Update an existing custom field definition: value: name: Renamed String responses: '200': description: >- Update options for an existing Dropdown Custom Field / Update a String Custom Field headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: keep-alive Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Wed, 21 Nov 2018 19:53:35 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: nginx/1.15.5 Set-Cookie: schema: type: string example: >- _ALI_session_v2=eyJzZXNzaW9uX2lkIjoiMzQ0NWRmMDAxZjhkMDUyNjY4ZGQ0ZWFjZGI0YWU0OWEiLCJ3YXJkZW4udXNlci51c2VyLmtleSI6W1sxXSwiJDJhJDEwJGNWSERqRmJTTXoyS2ZqV3JJZmxQRS4iXSwid2FyZGVuLnVzZXIudXNlci5zZXNzaW9uIjp7Imxhc3RfcmVxdWVzdF9hdCI6MTU0Mjc1NjMwOX19--a27335fb04df5f063cfbf3ba1f7ae43395bca86a; domain=lvh.me; path=/; expires=Thu, 21 Nov 2019 19:53:35 -0000; HttpOnly Strict-Transport-Security: schema: type: string example: max-age=31536000; includeSubDomains Transfer-Encoding: schema: type: string example: chunked Vary: schema: type: string example: Accept-Encoding, Origin X-Content-Type-Options: schema: type: string example: nosniff X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-CORS: schema: type: string example: miss; no-origin X-Request-Id: schema: type: string example: 26be0a6f-c63d-4071-afa2-fc7e2b0c6be7 X-Runtime: schema: type: string example: '0.354684' X-XSS-Protection: schema: type: string example: 1; mode=block content: application/json: schema: $ref: >- #/components/schemas/CustomFieldsUpdateExistingDefinitionResponse examples: Update a String Custom Field: value: available_on: [] canonical_name: null data_type: String id: 7 name: Renamed String Update options for an existing Dropdown Custom Field: value: available_on: - lead - person - opportunity canonical_name: null data_type: Dropdown id: 3 name: A Dropdown options: - id: 7 name: Option 1 rank: 0 - id: 8 name: Option 2 rank: 1 - id: 9 name: Option 3 rank: 2 delete: tags: - Custom Fields - General summary: Delete a Custom Field Definition operationId: CustomFields_deleteCustomFieldDefinition description: Delete a Custom Field Definition parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: text/plain: examples: Delete a Custom Field Definition: value: '' schema: description: >- WARNING: Missing schema in media type object. Missing schema has been filled with this AnyType schema. responses: '200': description: Delete a Custom Field Definition headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: keep-alive Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Wed, 21 Nov 2018 20:08:28 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: nginx/1.15.5 Set-Cookie: schema: type: string example: >- _ALI_session_v2=eyJzZXNzaW9uX2lkIjoiMzQ0NWRmMDAxZjhkMDUyNjY4ZGQ0ZWFjZGI0YWU0OWEiLCJ3YXJkZW4udXNlci51c2VyLmtleSI6W1sxXSwiJDJhJDEwJGNWSERqRmJTTXoyS2ZqV3JJZmxQRS4iXSwid2FyZGVuLnVzZXIudXNlci5zZXNzaW9uIjp7Imxhc3RfcmVxdWVzdF9hdCI6MTU0Mjc1NjMwOX19--a27335fb04df5f063cfbf3ba1f7ae43395bca86a; domain=lvh.me; path=/; expires=Thu, 21 Nov 2019 20:08:28 -0000; HttpOnly Strict-Transport-Security: schema: type: string example: max-age=31536000; includeSubDomains Transfer-Encoding: schema: type: string example: chunked Vary: schema: type: string example: Accept-Encoding, Origin X-Content-Type-Options: schema: type: string example: nosniff X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-CORS: schema: type: string example: miss; no-origin X-Request-Id: schema: type: string example: e0e0f76b-63f9-4c0b-93d3-6ab4be514813 X-Runtime: schema: type: string example: '0.684232' X-XSS-Protection: schema: type: string example: 1; mode=block content: application/json: schema: $ref: >- #/components/schemas/CustomFieldsDeleteCustomFieldDefinitionResponse examples: Delete a Custom Field Definition: value: id: 6 is_deleted: true /{entity_name_in_plural}/search: parameters: - name: entity_name_in_plural in: path required: true schema: type: string post: tags: - Custom Fields - General summary: Search Entity (Leads, People, etc) by Custom Field operationId: CustomFields_searchEntityByCustomField description: >- Custom fields are available for each of the entities (Leads, People, Companies, Opportunities, Projects, and Tasks). Custom field types include: Text Field, Text Area, Dropdown, Date, Checkbox, Number Field, URL, Percentage, Currency, and Multi-Select Dropdown. Text fields are not searchable at this point. The table below summarizes the behavior of each of these fields. | Field | Type | Search for Empty Value? | Any, All, None Options | | --------------------- | ------------- | ----------------------- | ---------------------- | | Dropdown | integer array | Yes | No | | Date | integer range | No | No | | Checkbox | boolean | No | No | | Number Field | numeric | No | No | | Percentage | numeric range | No | No | | Currency | integer range | No | No | | Multi-Select Dropdown | integer array | Yes | Yes | Except for text-related fields, each custom field can be searched via the dev API search endpoint for any of the entities. For Leads, this would be the endpoint `/leads/search`. Dropdown and Multi-Select Dropdown fields have the additional option of searching for records where dropdown and multi-select dropdown fields are empty. This can be accomplished by adding an additional field: { "allow_empty": true }. Searching by Multi-select dropdown also allows searching if any, all, or none of the dropdown options are to be searched. These options can be used together. Examples of searching for each of the searchable fields can be found under the dropdown menu on the right. Examples given are for `Leads` and can be easily interchanged with any other entity. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: >- #/components/schemas/CustomFieldsSearchEntityByCustomFieldRequest examples: Search Entity (Leads, People, etc) by Custom Field: value: custom_fields: - allow_empty: true custom_field_definition_id: 3 responses: '200': description: >- Search Custom Checkbox Field / Search Custom Currency Field / Search Custom Percentage Field / Search Custom Date Field / Search Custom Multi-Select Dropdown Field / Search Custom Dropdown Field / Search Custom Number Field / Search Custom Multi-Select Dropdown Field for Both Set Value and Empty Value / Search Custom Dropdown Field for Empty Value headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: keep-alive Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Thu, 15 Feb 2018 01:23:07 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: nginx/1.13.8 Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJWZhYjFlMDZmYjQ2NDI1NzZkMjNmNDg0MmVmYzFlYjg0BjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMThZYjdrem5CY0pXRnFTNlQvb3hzR0c5UnJONkVFOGRnWmxRaFBGSFZISE09BjsARg%3D%3D--4be83050370048f138320e87742f417236d34137; domain=lvh.me; path=/; expires=Fri, 15-Feb-2019 01:23:07 GMT; HttpOnly Status: schema: type: string example: 200 OK Transfer-Encoding: schema: type: string example: chunked Vary: schema: type: string example: Accept-Encoding X-Frame-Options: schema: type: string example: SAMEORIGIN X-PW-TOTAL: schema: type: string example: '1' X-Rack-CORS: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: b6c68a8529cfb2b69ce9793cf90c9eec X-Runtime: schema: type: string example: '1.116600' X-UA-Compatible: schema: type: string example: IE=Edge content: application/json: schema: $ref: >- #/components/schemas/CustomFieldsSearchEntityByCustomFieldResponse examples: Search Custom Checkbox Field: value: - tags: - sample title: Manager address: city: Scranton country: null postal_code: '18503' state: PA street: 213 West Main St assignee_id: null company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 1 value: Blah - custom_field_definition_id: 2 value: blah blah blah - custom_field_definition_id: 3 value: 1 - custom_field_definition_id: 4 value: 1518595200 - custom_field_definition_id: 5 value: true - custom_field_definition_id: 6 value: 42 - custom_field_definition_id: 7 value: http://blah.com - custom_field_definition_id: 8 value: 50 - custom_field_definition_id: 9 value: 1000 - custom_field_definition_id: 10 value: - 3 customer_source_id: 1 date_created: 1518656437 date_last_contacted: null date_modified: 1518657195 details: >- A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity. Once your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works! email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample) id: 2 interaction_count: 0 last_name: null middle_name: null monetary_unit: null monetary_value: 2500 name: Jim Halpert (sample) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 1 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Custom Currency Field: value: - tags: - sample title: Manager address: city: Scranton country: null postal_code: '18503' state: PA street: 213 West Main St assignee_id: null company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 1 value: Blah - custom_field_definition_id: 2 value: blah blah blah - custom_field_definition_id: 3 value: 1 - custom_field_definition_id: 4 value: 1518595200 - custom_field_definition_id: 5 value: true - custom_field_definition_id: 6 value: 42 - custom_field_definition_id: 7 value: http://blah.com - custom_field_definition_id: 8 value: 50 - custom_field_definition_id: 9 value: 1000 - custom_field_definition_id: 10 value: - 3 customer_source_id: 1 date_created: 1518656437 date_last_contacted: null date_modified: 1518657195 details: >- A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity. Once your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works! email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample) id: 2 interaction_count: 0 last_name: null middle_name: null monetary_unit: null monetary_value: 2500 name: Jim Halpert (sample) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 1 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Custom Date Field: value: - tags: - sample title: Manager address: city: Scranton country: null postal_code: '18503' state: PA street: 213 West Main St assignee_id: null company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 1 value: Blah - custom_field_definition_id: 2 value: blah blah blah - custom_field_definition_id: 3 value: 1 - custom_field_definition_id: 4 value: 1518595200 - custom_field_definition_id: 5 value: true - custom_field_definition_id: 6 value: 42 - custom_field_definition_id: 7 value: http://blah.com - custom_field_definition_id: 8 value: 50 - custom_field_definition_id: 9 value: 1000 - custom_field_definition_id: 10 value: - 3 customer_source_id: 1 date_created: 1518656437 date_last_contacted: null date_modified: 1518657195 details: >- A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity. Once your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works! email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample) id: 2 interaction_count: 0 last_name: null middle_name: null monetary_unit: null monetary_value: 2500 name: Jim Halpert (sample) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 1 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Custom Dropdown Field: value: - tags: - sample title: Manager address: city: Scranton country: null postal_code: '18503' state: PA street: 213 West Main St assignee_id: null company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 1 value: Blah - custom_field_definition_id: 2 value: blah blah blah - custom_field_definition_id: 3 value: 1 - custom_field_definition_id: 4 value: 1518595200 - custom_field_definition_id: 5 value: true - custom_field_definition_id: 6 value: 42 - custom_field_definition_id: 7 value: http://blah.com - custom_field_definition_id: 8 value: 50 - custom_field_definition_id: 9 value: 1000 - custom_field_definition_id: 10 value: - 3 customer_source_id: 1 date_created: 1518656437 date_last_contacted: null date_modified: 1518657195 details: >- A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity. Once your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works! email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample) id: 2 interaction_count: 0 last_name: null middle_name: null monetary_unit: null monetary_value: 2500 name: Jim Halpert (sample) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 1 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Custom Dropdown Field for Empty Value: value: - tags: - sample title: Office Coordinator address: null assignee_id: null company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 1 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 10 value: [] - custom_field_definition_id: 2 value: null - custom_field_definition_id: 8 value: null - custom_field_definition_id: 7 value: null - custom_field_definition_id: 5 value: false - custom_field_definition_id: 3 value: null customer_source_id: 1 date_created: 1518656436 date_last_contacted: null date_modified: 1518656436 details: >- A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity. Once your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works! email: category: work email: pam@dundermifflin.com first_name: Pam Beesly (sample) id: 1 interaction_count: 0 last_name: null middle_name: null monetary_unit: null monetary_value: 5000 name: Pam Beesly (sample) phone_numbers: - category: work number: '5105553333' prefix: null socials: [] status: New status_id: 1 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Custom Multi-Select Dropdown Field: value: - tags: - sample title: Manager address: city: Scranton country: null postal_code: '18503' state: PA street: 213 West Main St assignee_id: null company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 1 value: Blah - custom_field_definition_id: 2 value: blah blah blah - custom_field_definition_id: 3 value: 1 - custom_field_definition_id: 4 value: 1518595200 - custom_field_definition_id: 5 value: true - custom_field_definition_id: 6 value: 42 - custom_field_definition_id: 7 value: http://blah.com - custom_field_definition_id: 8 value: 50 - custom_field_definition_id: 9 value: 1000 - custom_field_definition_id: 10 value: - 3 customer_source_id: 1 date_created: 1518656437 date_last_contacted: null date_modified: 1518657195 details: >- A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity. Once your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works! email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample) id: 2 interaction_count: 0 last_name: null middle_name: null monetary_unit: null monetary_value: 2500 name: Jim Halpert (sample) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 1 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Custom Multi-Select Dropdown Field for Both Set Value and Empty Value: value: - tags: - sample title: Manager address: city: Scranton country: null postal_code: '18503' state: PA street: 213 West Main St assignee_id: null company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 1 value: Blah - custom_field_definition_id: 2 value: blah blah blah - custom_field_definition_id: 3 value: 1 - custom_field_definition_id: 4 value: 1518595200 - custom_field_definition_id: 5 value: true - custom_field_definition_id: 6 value: 42 - custom_field_definition_id: 7 value: http://blah.com - custom_field_definition_id: 8 value: 50 - custom_field_definition_id: 9 value: 1000 - custom_field_definition_id: 10 value: - 3 customer_source_id: 1 date_created: 1518656437 date_last_contacted: null date_modified: 1518657195 details: >- A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity. Once your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works! email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample) id: 2 interaction_count: 0 last_name: null middle_name: null monetary_unit: null monetary_value: 2500 name: Jim Halpert (sample) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 1 suffix: null websites: - category: work url: http://www.dundermifflin.com - tags: - sample title: Office Coordinator address: null assignee_id: null company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 1 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 10 value: [] - custom_field_definition_id: 2 value: null - custom_field_definition_id: 8 value: null - custom_field_definition_id: 7 value: null - custom_field_definition_id: 5 value: false - custom_field_definition_id: 3 value: null customer_source_id: 1 date_created: 1518656436 date_last_contacted: null date_modified: 1518656436 details: >- A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity. Once your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works! email: category: work email: pam@dundermifflin.com first_name: Pam Beesly (sample) id: 1 interaction_count: 0 last_name: null middle_name: null monetary_unit: null monetary_value: 5000 name: Pam Beesly (sample) phone_numbers: - category: work number: '5105553333' prefix: null socials: [] status: New status_id: 1 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Custom Number Field: value: - tags: - sample title: Manager address: city: Scranton country: null postal_code: '18503' state: PA street: 213 West Main St assignee_id: null company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 1 value: Blah - custom_field_definition_id: 2 value: blah blah blah - custom_field_definition_id: 3 value: 1 - custom_field_definition_id: 4 value: 1518595200 - custom_field_definition_id: 5 value: true - custom_field_definition_id: 6 value: 42 - custom_field_definition_id: 7 value: http://blah.com - custom_field_definition_id: 8 value: 50 - custom_field_definition_id: 9 value: 1000 - custom_field_definition_id: 10 value: - 3 customer_source_id: 1 date_created: 1518656437 date_last_contacted: null date_modified: 1518657195 details: >- A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity. Once your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works! email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample) id: 2 interaction_count: 0 last_name: null middle_name: null monetary_unit: null monetary_value: 2500 name: Jim Halpert (sample) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 1 suffix: null websites: - category: work url: http://www.dundermifflin.com Search Custom Percentage Field: value: - tags: - sample title: Manager address: city: Scranton country: null postal_code: '18503' state: PA street: 213 West Main St assignee_id: null company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 1 value: Blah - custom_field_definition_id: 2 value: blah blah blah - custom_field_definition_id: 3 value: 1 - custom_field_definition_id: 4 value: 1518595200 - custom_field_definition_id: 5 value: true - custom_field_definition_id: 6 value: 42 - custom_field_definition_id: 7 value: http://blah.com - custom_field_definition_id: 8 value: 50 - custom_field_definition_id: 9 value: 1000 - custom_field_definition_id: 10 value: - 3 customer_source_id: 1 date_created: 1518656437 date_last_contacted: null date_modified: 1518657195 details: >- A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity. Once your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works! email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample) id: 2 interaction_count: 0 last_name: null middle_name: null monetary_unit: null monetary_value: 2500 name: Jim Halpert (sample) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 1 suffix: null websites: - category: work url: http://www.dundermifflin.com /custom_activity_types: get: tags: - Custom Fields - General summary: List All Custom Activity Types operationId: CustomFields_listAllActivityTypes description: List All Custom Activity Types parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: List All Custom Activity Types headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: keep-alive Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 11 Dec 2018 17:25:19 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: nginx/1.15.5 Set-Cookie: schema: type: string example: >- _ALI_session_v2=eyJzZXNzaW9uX2lkIjoiYmFmYzdlOWU5ZjVkYzQ0ZGI2MDkyY2FlMDU3OTA4NmUifQ%3D%3D--99648aa0c7d2e46891b21ea642ce337eff04f99b; domain=lvh.me; path=/; expires=Wed, 11 Dec 2019 17:25:19 -0000; HttpOnly Strict-Transport-Security: schema: type: string example: max-age=31536000; includeSubDomains Transfer-Encoding: schema: type: string example: chunked Vary: schema: type: string example: Accept-Encoding, Origin X-Content-Type-Options: schema: type: string example: nosniff X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-CORS: schema: type: string example: miss; no-origin X-Request-Id: schema: type: string example: a827aee7-4cb0-4a89-ae73-5ae4259e3e89 X-Runtime: schema: type: string example: '0.102564' X-XSS-Protection: schema: type: string example: 1; mode=block content: application/json: schema: $ref: '#/components/schemas/CustomFieldsListAllActivityTypesResponse' examples: List All Custom Activity Types: value: - company_id: 1 icon_type: Phone id: 1 is_default_task_type: null is_disabled: false is_interaction: true name: Phone Call - company_id: 1 icon_type: Event id: 2 is_default_task_type: null is_disabled: false is_interaction: true name: Meeting - company_id: 1 icon_type: Todo id: 3 is_default_task_type: true is_disabled: false is_interaction: false name: To Do - company_id: 1 icon_type: Event id: 4 is_default_task_type: null is_disabled: false is_interaction: true name: Custom Meeting post: tags: - Custom Fields - General summary: Create a New Custom Activity Type operationId: CustomFields_createCustomActivityType description: >- | Field | Type | Details | Default | | --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | - | | name* | string | Name of the custom activity type. | | | icon_type* | string | Icon Type. Must be one of: "Message", "Phone", "Event", "Assignment", "Assessment", "Group", "Description", "Speaker Notes", "Forum", "Web", "Loyalty", "Content Paste", "Headset", "Share", "Navigation", "Notification", "Voicemail", "Room", "Edit", "Send", "Videocam", "Play Arrow", "Grocery Store", "Mic", "Camera Mic", "Todo" | | *indicates a required field parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomFieldsCreateCustomActivityTypeRequest' examples: Create a New Custom Activity Type: value: icon_type: Phone name: New Activity responses: '200': description: Create a New Custom Activity Type headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: keep-alive Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 11 Dec 2018 17:33:27 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: nginx/1.15.5 Set-Cookie: schema: type: string example: >- _ALI_session_v2=eyJzZXNzaW9uX2lkIjoiYmFmYzdlOWU5ZjVkYzQ0ZGI2MDkyY2FlMDU3OTA4NmUifQ%3D%3D--99648aa0c7d2e46891b21ea642ce337eff04f99b; domain=lvh.me; path=/; expires=Wed, 11 Dec 2019 17:33:27 -0000; HttpOnly Strict-Transport-Security: schema: type: string example: max-age=31536000; includeSubDomains Transfer-Encoding: schema: type: string example: chunked Vary: schema: type: string example: Accept-Encoding, Origin X-Content-Type-Options: schema: type: string example: nosniff X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-CORS: schema: type: string example: miss; no-origin X-Request-Id: schema: type: string example: 15d46d9f-3c0a-41f3-8c3f-0c2616a33c69 X-Runtime: schema: type: string example: '0.120899' X-XSS-Protection: schema: type: string example: 1; mode=block content: application/json: schema: $ref: >- #/components/schemas/CustomFieldsCreateCustomActivityTypeResponse examples: Create a New Custom Activity Type: value: company_id: 1 icon_type: Phone id: 5 is_default_task_type: null is_disabled: false is_interaction: false name: New Activity /custom_activity_types/{custom_activity_type_id}: parameters: - name: custom_activity_type_id in: path required: true schema: type: string get: tags: - Custom Fields - General summary: Get Custom Activity Type operationId: CustomFields_getActivityType description: Get Custom Activity Type parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: Get Custom Activity Type headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: keep-alive Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 11 Dec 2018 17:28:55 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: nginx/1.15.5 Set-Cookie: schema: type: string example: >- _ALI_session_v2=eyJzZXNzaW9uX2lkIjoiYmFmYzdlOWU5ZjVkYzQ0ZGI2MDkyY2FlMDU3OTA4NmUifQ%3D%3D--99648aa0c7d2e46891b21ea642ce337eff04f99b; domain=lvh.me; path=/; expires=Wed, 11 Dec 2019 17:28:55 -0000; HttpOnly Strict-Transport-Security: schema: type: string example: max-age=31536000; includeSubDomains Transfer-Encoding: schema: type: string example: chunked Vary: schema: type: string example: Accept-Encoding, Origin X-Content-Type-Options: schema: type: string example: nosniff X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-CORS: schema: type: string example: miss; no-origin X-Request-Id: schema: type: string example: dc0b021f-2132-48dc-ba03-7ddfa0d74c44 X-Runtime: schema: type: string example: '0.104607' X-XSS-Protection: schema: type: string example: 1; mode=block content: application/json: schema: $ref: '#/components/schemas/CustomFieldsGetActivityTypeResponse' examples: Get Custom Activity Type: value: company_id: 1 icon_type: Event id: 4 is_default_task_type: null is_disabled: false is_interaction: true name: Custom Meeting put: tags: - Custom Fields - General summary: Update an Existing Custom Activity Type operationId: CustomFields_updateExistingActivityType description: >- | Field | Type | Details | Default | | --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | - | | name | string | Name of the custom activity type. | | | icon_type | string | Icon Type. Must be one of: "Message", "Phone", "Event", "Assignment", "Assessment", "Group", "Description", "Speaker Notes", "Forum", "Web", "Loyalty", "Content Paste", "Headset", "Share", "Navigation", "Notification", "Voicemail", "Room", "Edit", "Send", "Videocam", "Play Arrow", "Grocery Store", "Mic", "Camera Mic", "Todo" | | parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: >- #/components/schemas/CustomFieldsUpdateExistingActivityTypeRequest examples: Update an Existing Custom Activity Type: value: icon_type: Todo responses: '200': description: Update an Existing Custom Activity Type headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: keep-alive Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 11 Dec 2018 18:34:22 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: nginx/1.15.5 Set-Cookie: schema: type: string example: >- _ALI_session_v2=eyJzZXNzaW9uX2lkIjoiYmFmYzdlOWU5ZjVkYzQ0ZGI2MDkyY2FlMDU3OTA4NmUifQ%3D%3D--99648aa0c7d2e46891b21ea642ce337eff04f99b; domain=lvh.me; path=/; expires=Wed, 11 Dec 2019 18:34:22 -0000; HttpOnly Strict-Transport-Security: schema: type: string example: max-age=31536000; includeSubDomains Transfer-Encoding: schema: type: string example: chunked Vary: schema: type: string example: Accept-Encoding, Origin X-Content-Type-Options: schema: type: string example: nosniff X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-CORS: schema: type: string example: miss; no-origin X-Request-Id: schema: type: string example: 88eed9f9-11d0-415e-ab38-f6edfd1e6b7f X-Runtime: schema: type: string example: '0.146047' X-XSS-Protection: schema: type: string example: 1; mode=block content: application/json: schema: $ref: >- #/components/schemas/CustomFieldsUpdateExistingActivityTypeResponse examples: Update an Existing Custom Activity Type: value: company_id: 1 icon_type: Todo id: 5 is_default_task_type: null is_disabled: false is_interaction: false name: New Activity /related_links: get: tags: - Custom Fields - Connect Fields summary: List the connections on specified entity operationId: CustomFields_getConnections description: >- To retrieve already existing connections in the connect field, use the list the connections API. parameters: - description: >- The Id of the custom field definition. This can be fetched by the custom_field_definitions API. name: custom_field_definition_id in: query schema: type: string example: '{{custom_field_definition_id}}' - description: >- The entity type of the source. Supported sources: "people", "opportunity", "lead", "organization", "project", "user" name: source_type in: query schema: type: string example: '{{source_type}}' - description: The Copper record id for the specified entity type name: source_id in: query schema: type: string example: '{{source_id}}' - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: List the connections on specified entity headers: Cache-Control: schema: type: string example: no-cache Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Fri, 05 Oct 2018 00:35:15 GMT Server: schema: type: string example: Cowboy Strict-Transport-Security: schema: type: string example: max-age=31536000; includeSubDomains Vary: schema: type: string example: Accept-Encoding, Origin Via: schema: type: string example: 1.1 vegur X-Content-Type-Options: schema: type: string example: nosniff X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: miss; no-origin X-Request-Id: schema: type: string example: efbd01a7-1006-43c6-a285-b049b213c6db X-Runtime: schema: type: string example: '0.032144' X-Xss-Protection: schema: type: string example: 1; mode=block content: application/json: schema: $ref: '#/components/schemas/CustomFieldsGetConnectionsResponse' examples: List the connections on specified entity: value: - custom_field_definition_id: 172 id: 375 source: entity_type: people id: 1021 name: '1021' target: entity_type: user id: 155 name: deque deque post: tags: - Custom Fields - Connect Fields summary: Create a connection operationId: CustomFields_createConnection description: >- Once you have created connect fields, use the create a connection API to add connections to the connect field. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomFieldsCreateConnectionRequest' examples: Create a connection: value: custom_field_definition_id: 169 source: entity_type: lead id: 1001 target: entity_type: lead id: 1002 responses: '200': description: Create a new connection headers: Cache-Control: schema: type: string example: no-cache Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Fri, 05 Oct 2018 00:42:57 GMT Server: schema: type: string example: Cowboy Strict-Transport-Security: schema: type: string example: max-age=31536000; includeSubDomains Vary: schema: type: string example: Accept-Encoding, Origin Via: schema: type: string example: 1.1 vegur X-Content-Type-Options: schema: type: string example: nosniff X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: miss; no-origin X-Request-Id: schema: type: string example: 28b1ef8f-bc73-41ca-9e56-154e4aba6d56 X-Runtime: schema: type: string example: '0.014745' X-Xss-Protection: schema: type: string example: 1; mode=block content: application/json: schema: $ref: '#/components/schemas/CustomFieldsCreateConnectionResponse' examples: Create a new connection: value: custom_field_definition_id: 169 id: 2103 source: entity_type: lead id: 1001 name: '1001' target: entity_type: lead id: 1002 name: '1002' /related_links/{connection_id}: parameters: - name: connection_id in: path required: true schema: type: string delete: tags: - Custom Fields - Connect Fields summary: Delete a connection operationId: CustomFields_deleteConnection description: >- To delete already existing connections in the connect field, use the delete a connection API. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: text/plain: examples: Delete a connection: value: '' schema: description: >- WARNING: Missing schema in media type object. Missing schema has been filled with this AnyType schema. responses: '200': description: Delete a connection headers: Cache-Control: schema: type: string example: no-cache Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Fri, 05 Oct 2018 00:45:12 GMT Server: schema: type: string example: Cowboy Strict-Transport-Security: schema: type: string example: max-age=31536000; includeSubDomains Vary: schema: type: string example: Accept-Encoding, Origin Via: schema: type: string example: 1.1 vegur X-Content-Type-Options: schema: type: string example: nosniff X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: miss; no-origin X-Request-Id: schema: type: string example: 47ee197f-f78f-4e1b-9f74-089848daa4bc X-Runtime: schema: type: string example: '0.014139' X-Xss-Protection: schema: type: string example: 1; mode=block content: application/json: schema: $ref: '#/components/schemas/CustomFieldsDeleteConnectionResponse' examples: Delete a connection: value: ids: - 40085 - 40086 is_deleted: true /{entity}/{entity_id}/related/{related_entity_name}: parameters: - name: entity in: path required: true schema: type: string - name: entity_id in: path required: true schema: type: string - name: related_entity_name in: path required: true schema: type: string get: tags: - Related Items summary: View all records of a given Entity Type related to an Entity operationId: RelatedItems_viewAllRelated description: View all records of a given Entity Type related to an Entity parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: Related Opportunities to Person headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Thu, 08 Jun 2017 17:37:45 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJWQzMzExMjA0MjY2MGFjNTgwMjQ0MzNhNGJhZDcwMmExBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMS93bGhRUXRNVkZUeENRQjJDdVByUEkvMEx3c2FqZDVJSVBFc2NFOFowQUU9BjsARg%3D%3D--17929806d9ee75df558e2ff85c3fd102d6399da1; domain=prosperworks.com; path=/; expires=Fri, 08-Jun-2018 17:37:45 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 5cbb77f7-19f0-4e3f-bc35-a2bdd81c19be X-Runtime: schema: type: string example: '0.325915' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/RelatedItemsViewAllRelatedResponse' examples: Related Opportunities to Person: value: - id: 4417020 type: opportunity - id: 4418567 type: opportunity /{entity}/{entity_id}/related: parameters: - name: entity in: path required: true schema: type: string - name: entity_id in: path required: true schema: type: string get: tags: - Related Items summary: View all records related to an Entity operationId: RelatedItems_getAllRelated description: View all records related to an Entity parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: All related rcords headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Thu, 08 Jun 2017 17:36:08 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJWQzMzExMjA0MjY2MGFjNTgwMjQ0MzNhNGJhZDcwMmExBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMS93bGhRUXRNVkZUeENRQjJDdVByUEkvMEx3c2FqZDVJSVBFc2NFOFowQUU9BjsARg%3D%3D--17929806d9ee75df558e2ff85c3fd102d6399da1; domain=prosperworks.com; path=/; expires=Fri, 08-Jun-2018 17:36:08 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: cbb71b34-8e88-454a-be26-0da3cce9ee39 X-Runtime: schema: type: string example: '0.191328' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/RelatedItemsGetAllRelatedResponse' examples: All related rcords: value: - id: 208105 type: project - id: 4417020 type: opportunity - id: 4418567 type: opportunity - id: 13358412 type: company /{entity_type}/{entity_id}/files: parameters: - name: entity_type in: path required: true schema: type: string - name: entity_id in: path required: true schema: type: string get: tags: - File Upload summary: List attached files of an entity record operationId: FileUpload_listAttachedFiles description: >- This API endpoint lists all the attached files for a given entity type and id, where {{entity_type}} and {{entity_id}} are replaced with the following: | Field | Type | Details | Default | | ------------------------- | ----------- | ----------------------------------------------------------------------------- | ------- | | entity_type* | string | Must be one of: "leads", "people", "opportunities", "companies", "projects" | | | entity_id* | number | ID of the entity record | | | \* indicates a required field |||| parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: List attached files of an existing lead headers: Alt-Svc: schema: type: string example: clear Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Thu, 16 May 2019 23:37:42 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: nginx Strict-Transport-Security: schema: type: string example: max-age=31536000; includeSubDomains Transfer-Encoding: schema: type: string example: chunked Vary: schema: type: string example: Accept-Encoding, Origin Via: schema: type: string example: 1.1 google X-Content-Type-Options: schema: type: string example: nosniff X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-CORS: schema: type: string example: miss; no-origin X-Request-Id: schema: type: string example: 9ae94a3e-59e0-411c-97a5-7ea272e0a321 X-Runtime: schema: type: string example: '0.201445' X-XSS-Protection: schema: type: string example: 1; mode=block content: application/json: schema: $ref: '#/components/schemas/FileUploadListAttachedFilesResponse' examples: List attached files of an existing lead: value: - content_type: binary/octet-stream creator_id: 46748 date_created: 1558049825 date_modified: null file_name: picture.png file_size: 3113 id: 2556402 is_deleted: false post: tags: - File Upload summary: 'Upload 3: Relate the uploaded file to a specific entity' operationId: FileUpload_relateToEntity description: >- This API endpoint is step 3 of 3 to upload a file and attach it to an existing entity. The endpoint relates the uploaded file to a specific entity, where {{entity_type}} and {{entity_id}} are replaced with the following: | Field | Type | Details | Default | | ------------------------- | ----------- | ----------------------------------------------------------------------------- | ------- | | entity_type* | string | Must be one of: "leads", "people", "opportunities", "companies", "projects" | | | entity_id* | number | ID of the entity record | | | \* indicates a required field |||| parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/FileUploadRelateToEntityRequest' examples: 'Upload 3: Relate the uploaded file to a specific entity': value: file_name: cat.jpeg key: >- temp_uploads/f0317718-9b56-4d28-bda4-985af6b75f56/b0c5afe5-3d87-495d-ae58-760fcafbadec responses: '200': description: 'Upload 3: Relate the uploaded file to a specific entity' headers: Alt-Svc: schema: type: string example: clear Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Mon, 10 Jun 2019 21:57:34 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: nginx Set-Cookie: schema: type: string example: >- _ALI_session_v2=eyJzZXNzaW9uX2lkIjoiMDA2NzYxMDM3NjFmOWUyMmE5NWUxZTNjYWEzODA4YzAifQ%3D%3D--13654f9a38dbfc9450b42f570a2a46d8d5f13ac6; domain=prosperworks.com; path=/; expires=Wed, 10 Jun 2020 21:57:34 -0000; secure; HttpOnly Strict-Transport-Security: schema: type: string example: max-age=31536000; includeSubDomains Transfer-Encoding: schema: type: string example: chunked Vary: schema: type: string example: Accept-Encoding, Origin Via: schema: type: string example: 1.1 google X-Content-Type-Options: schema: type: string example: nosniff X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-CORS: schema: type: string example: miss; no-origin X-Request-Id: schema: type: string example: 22321c0c-4dec-4c0e-91f6-fa615b943aaa X-Runtime: schema: type: string example: '0.764353' X-XSS-Protection: schema: type: string example: 1; mode=block content: application/json: schema: $ref: '#/components/schemas/FileUploadRelateToEntityResponse' examples: 'Upload 3: Relate the uploaded file to a specific entity': value: content_type: binary/octet-stream creator_id: 342164 date_created: 1560203853 date_modified: 1560203854 file_name: cat.jpeg file_size: 38 id: 469753997 is_deleted: false /{entity}/{entity_id}/files/{file_id}: parameters: - name: entity in: path required: true schema: type: string - name: entity_id in: path required: true schema: type: string - name: file_id in: path required: true schema: type: string get: tags: - File Upload summary: Get metadata of a specific attached file operationId: FileUpload_getFileMetadata description: >- This API endpoint gets the detailed metadata for a file for a given entity type and id and the file id. File id can be found using the "List attached files of an entity record", where {{entity_type}}, {{entity_id}}, and {{file_id}} are replaced with the following: | Field | Type | Details | Default | | ------------------------- | ----------- | ----------------------------------------------------------------------------- | ------- | | entity_type* | string | Must be one of: "leads", "people", "opportunities", "companies", "projects" | | | entity_id* | number | ID of the entity record | | | file_id* | number | ID of the attached file | | | \* indicates a required field |||| parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: Get metadata of a specific attached file on an existing lead headers: Alt-Svc: schema: type: string example: clear Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Thu, 16 May 2019 23:39:37 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: nginx Strict-Transport-Security: schema: type: string example: max-age=31536000; includeSubDomains Transfer-Encoding: schema: type: string example: chunked Vary: schema: type: string example: Accept-Encoding, Origin Via: schema: type: string example: 1.1 google X-Content-Type-Options: schema: type: string example: nosniff X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-CORS: schema: type: string example: miss; no-origin X-Request-Id: schema: type: string example: ddf5e0c8-597f-491f-a4ee-d9eb5088c007 X-Runtime: schema: type: string example: '0.973095' X-XSS-Protection: schema: type: string example: 1; mode=block content: application/json: schema: $ref: '#/components/schemas/FileUploadGetFileMetadataResponse' examples: Get metadata of a specific attached file on an existing lead: value: content_type: binary/octet-stream creator_id: 46748 date_created: 1558049825 date_modified: 1558049826 file_name: picture.png file_size: 3113 id: 2556402 is_deleted: false /{entity_type}/{entity_id}/files/s3_signed_url: parameters: - name: entity_type in: path required: true schema: type: string - name: entity_id in: path required: true schema: type: string get: tags: - File Upload summary: 'Upload 1: Get signed S3 URL' operationId: FileUpload_getSignedS3Url description: >- This API endpoint is step 1 of 3 to upload a file and attach it to an existing entity. The endpoint gets a signed S3 URL to start the upload process, where {{entity_type}} and {{entity_id}} are replaced with the following: | Field | Type | Details | Default | | ------------------------- | ----------- | ----------------------------------------------------------------------------- | ------- | | entity_type* | string | Must be one of: "leads", "people", "opportunities", "companies", "projects" | | | entity_id* | number | ID of the entity record | | | \* indicates a required field |||| parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: >- Upload 1: Get signed S3 URL to upload file to leads entity / Delete a file headers: Alt-Svc: schema: type: string example: clear Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Mon, 17 Jun 2019 18:58:19 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: nginx Set-Cookie: schema: type: string example: >- _ALI_session_v2=eyJzZXNzaW9uX2lkIjoiMDA2NzYxMDM3NjFmOWUyMmE5NWUxZTNjYWEzODA4YzAifQ%3D%3D--13654f9a38dbfc9450b42f570a2a46d8d5f13ac6; domain=prosperworks.com; path=/; expires=Wed, 17 Jun 2020 18:58:19 -0000; secure; HttpOnly Strict-Transport-Security: schema: type: string example: max-age=31536000; includeSubDomains Transfer-Encoding: schema: type: string example: chunked Vary: schema: type: string example: Accept-Encoding, Origin Via: schema: type: string example: 1.1 google X-Content-Type-Options: schema: type: string example: nosniff X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-CORS: schema: type: string example: miss; no-origin X-Request-Id: schema: type: string example: 4725edc8-97f8-461d-aca1-271c6fd73675 X-Runtime: schema: type: string example: '1.036818' X-XSS-Protection: schema: type: string example: 1; mode=block content: application/json: schema: $ref: '#/components/schemas/FileUploadGetSignedS3UrlResponse' examples: Delete a file: value: removed: true resource: id: 473015532 type: filedocument 'Upload 1: Get signed S3 URL to upload file to leads entity': value: body: acl: private aws_access_key_id: AKIAJ2SYRNMGJJWLRENA key: >- temp_uploads/c3d7ff51-141f-420e-9b89-2946c98f38b6/8583d027-e1d3-4c9d-b184-8b0d6b100ec6 policy: >- eyJleHBpcmF0aW9uIjoiMjAxOS0wNS0xN1QxODoyNzozOC4wMDBaIiwiY29uZGl0aW9ucyI6W3siYnVja2V0IjoiYWxpLXVzZXJhc3NldHMtc3RhZ2luZyJ9LHsiYWNsIjoicHJpdmF0ZSJ9LHsia2V5IjoidGVtcF91cGxvYWRzL2MzZDdmZjUxLTE0MWYtNDIwZS05Yjg5LTI5NDZjOThmMzhiNi84NTgzZDAyNy1lMWQzLTRjOWQtYjE4NC04YjBkNmIxMDBlYzYifSxbImNvbnRlbnQtbGVuZ3RoLXJhbmdlIiwwLDEwNzM3NDE4MjRdLHsic3VjY2Vzc19hY3Rpb25fc3RhdHVzIjoiMjAxIn1dfQ== signature: nUUFLO43nlg/VzjaqeA+qFGg5+I= success_action_status: '201' method: POST sample_curl: > curl -X POST -v -F "key=temp_uploads/c3d7ff51-141f-420e-9b89-2946c98f38b6/8583d027-e1d3-4c9d-b184-8b0d6b100ec6" -F "signature=nUUFLO43nlg/VzjaqeA+qFGg5+I=" -F "success_action_status=201" -F "acl=private" -F "policy=eyJleHBpcmF0aW9uIjoiMjAxOS0wNS0xN1QxODoyNzozOC4wMDBaIiwiY29uZGl0aW9ucyI6W3siYnVja2V0IjoiYWxpLXVzZXJhc3NldHMtc3RhZ2luZyJ9LHsiYWNsIjoicHJpdmF0ZSJ9LHsia2V5IjoidGVtcF91cGxvYWRzL2MzZDdmZjUxLTE0MWYtNDIwZS05Yjg5LTI5NDZjOThmMzhiNi84NTgzZDAyNy1lMWQzLTRjOWQtYjE4NC04YjBkNmIxMDBlYzYifSxbImNvbnRlbnQtbGVuZ3RoLXJhbmdlIiwwLDEwNzM3NDE4MjRdLHsic3VjY2Vzc19hY3Rpb25fc3RhdHVzIjoiMjAxIn1dfQ==" -F "aws_access_key_id=AKIAJ2SYRNMGJJWLRENA" -F file=@your-file.txt "https://ali-userassets-staging.s3.amazonaws.com/" url: https://ali-userassets-staging.s3.amazonaws.com/ /: post: tags: - Webhooks summary: 'Upload 2: Upload your file to S3' operationId: Webhooks_uploadFileToS3 description: >- This API endpoint is step 2 of 3 to upload a file and attach it to an existing entity. The endpoint uploads the file to Amazon S3 service, in which the following parameters are required: | Field | Type | Details | Default | | ------------------------- | ----------- | ----------------------------------------------------------------------------- | ------- | | key* | string | Value of "key" from response of Upload 1 API endpoint | | | signature* | string | Value of "signature" from response of Upload 1 API endpoint | | | success_action_status* | string | Value of "success_action_status" from response of Upload 1 API endpoint | 201 | | acl* | string | Value of "acl" from response of Upload 1 API endpoint | private | | AWSAccessKeyId* | string | Value of "aws_access_key_id" from response of Upload 1 API endpoint | | | policy* | string | Value of "policy" from response of Upload 1 API endpoint | | | file* | string | String representing the full path to file on user's local computer | | | \* indicates a required field |||| parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/WebhooksUploadFileToS3Request' text/plain: examples: Notification Example: value: |- { "ids": [, , ...], "type": "", "event": "", "subscription_id": , "secret_field_1": "", "secret_field_2": "", "updated_attributes": { "field_name": [, ] } } schema: description: >- WARNING: Missing schema in media type object. Missing schema has been filled with this AnyType schema. responses: '201': description: 'Upload 2: Upload your file to S3' headers: Content-Length: schema: type: string example: '416' Date: schema: type: string example: Mon, 10 Jun 2019 21:52:51 GMT ETag: schema: type: string example: '"32ffc747a3857844479b6d21a6e5d46a"' Location: schema: type: string example: >- https://ali-userassets-production.s3.amazonaws.com/temp_uploads%2Ff0317718-9b56-4d28-bda4-985af6b75f56%2Fb0c5afe5-3d87-495d-ae58-760fcafbadec Server: schema: type: string example: AmazonS3 x-amz-id-2: schema: type: string example: >- 5+uNxjmQa3k78sRSE29bRDlxEoyqwgbX7fidL3oZaNGbdha3Dnx1l/6KNnwBw+UZdbTv6GvFLNI= x-amz-request-id: schema: type: string example: 8C0EAD3313E4FB4B x-amz-server-side-encryption: schema: type: string example: AES256 content: text/plain: examples: 'Upload 2: Upload your file to S3': value: |- https://ali-userassets-production.s3.amazonaws.com/temp_uploads%2Ff0317718-9b56-4d28-bda4-985af6b75f56%2Fb0c5afe5-3d87-495d-ae58-760fcafbadec ali-userassets-production temp_uploads/f0317718-9b56-4d28-bda4-985af6b75f56/b0c5afe5-3d87-495d-ae58-760fcafbadec "32ffc747a3857844479b6d21a6e5d46a" /webhooks: get: tags: - Webhooks summary: List all subscriptions operationId: Webhooks_listSubscriptions description: This is the description of the individual request parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: List all subscriptions headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Fri, 10 Nov 2017 00:06:18 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTZjM2U3YjM1OWM1YjgzNWJlNDU5ZjkyMjQzOGQ4ZjI5BjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMWROdEZ6bmp3VGJPcGVob0dMaGRuTWNTSXQ1OUdCcTB4eGxSMG0zOGswYm89BjsARg%3D%3D--3ad51899ac644aa454d3431d0fbdac8985ef0c6c; domain=prosperworks.com; path=/; expires=Sat, 10-Nov-2018 00:06:18 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 7eb273fe-87b4-4084-b81e-5f002a23ed54 X-Runtime: schema: type: string example: '0.160434' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/WebhooksListSubscriptionsResponse' examples: List all subscriptions: value: - created_at: 1489173015 event: update id: 17065 secret: key: copper_notifications secret: hook_source target: https://your.endpoint.here type: lead - created_at: 1496787761 event: update id: 25347 secret: key: copper_notifications secret: hook_source target: https://your.endpoint.here type: person - created_at: 1510271719 event: update id: 39285 secret: key: copper_notifications secret: hook_source target: https://hookb.in/KAnAXW5q type: activity_log - created_at: 1510271965 event: delete id: 39286 secret: key: copper_notifications secret: hook_source target: https://hookb.in/KAnAXW5q type: activity_log - created_at: 1510272356 event: new id: 39287 secret: key: copper_notifications secret: hook_source target: https://hookbin.com/bin/KAnAXW5q type: lead - created_at: 1510272369 event: new id: 39288 secret: key: copper_notifications secret: hook_source target: https://hookbin.com/bin/KAnAXW5q type: activity_log post: tags: - Webhooks summary: Create new subscription operationId: Webhooks_createSubscriptionEvent description: >- "event" = "new" | "update" | "delete" "type" = "lead" | "person" | "company" | "opportunity" | "project" | "task" Also, you may specify an optional hash object called "secret" containing custom key/value pairs that is sent with every notification. Using this secret your notification endpoint can authenticate the request to make sure it is coming from a trusted source. This example shows the creation of a new notification for events when existing Leads are updated. parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: application/json: schema: $ref: '#/components/schemas/WebhooksCreateSubscriptionEventRequest' examples: Create new subscription: value: event: update secret: key: copper_notifications secret: hook_source target: https://your.endpoint.here type: lead responses: '200': description: Create subscription headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Wed, 07 Jun 2017 17:31:21 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJWQzMzExMjA0MjY2MGFjNTgwMjQ0MzNhNGJhZDcwMmExBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMS93bGhRUXRNVkZUeENRQjJDdVByUEkvMEx3c2FqZDVJSVBFc2NFOFowQUU9BjsARg%3D%3D--17929806d9ee75df558e2ff85c3fd102d6399da1; domain=prosperworks.com; path=/; expires=Thu, 07-Jun-2018 17:31:21 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 2194489b-4cbe-44c1-8a50-4b4b6caae4eb X-Runtime: schema: type: string example: '0.115395' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/WebhooksCreateSubscriptionEventResponse' examples: Create subscription: value: created_at: 1489173015 event: update id: 17065 secret: key: copper_notifications secret: hook_source target: https://your.endpoint.here type: lead /webhooks/{example_webhook_id}: parameters: - name: example_webhook_id in: path required: true schema: type: string delete: tags: - Webhooks summary: Delete subscription (unsubscribe) operationId: Webhooks_unsubscribe description: This is the description of the individual request parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' requestBody: content: text/plain: examples: Delete subscription (unsubscribe): value: '' schema: description: >- WARNING: Missing schema in media type object. Missing schema has been filled with this AnyType schema. responses: '200': description: Delete webhook headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 06 Jun 2017 22:21:48 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Wed, 06-Jun-2018 22:21:48 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: 19656df3-19a7-4abe-be5d-e396ea3c1e04 X-Runtime: schema: type: string example: '0.184291' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/WebhooksUnsubscribeResponse' examples: Delete webhook: value: id: 17065 /webhooks{example_webhook_id}: parameters: - name: example_webhook_id in: path required: true schema: type: string get: tags: - Webhooks summary: View subscription by ID operationId: Webhooks_viewSubscriptionById description: This is the description of the individual request parameters: - name: x-pw-accesstoken in: header schema: type: string example: '{{api_token}}' - name: x-pw-application in: header schema: type: string example: developer_api - name: x-pw-useremail in: header schema: type: string example: '{{api_email}}' responses: '200': description: See Webhook by ID headers: Cache-Control: schema: type: string example: no-cache, no-store, max-age=0, must-revalidate Connection: schema: type: string example: close Content-Encoding: schema: type: string example: gzip Date: schema: type: string example: Tue, 06 Jun 2017 22:22:46 GMT Expires: schema: type: string example: Fri, 01 Jan 1990 00:00:00 GMT Pragma: schema: type: string example: no-cache Server: schema: type: string example: Cowboy Set-Cookie: schema: type: string example: >- _ALI_session_v2=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMyOTIzNDdmYTgxZTBjZDMxN2ZkOGU2ZDkyMDA0MGRkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMW9laUpuMHNFcVVQRk1Nem84RjVGWXZWVzhtTkNoWTZER1VzT1l2RnhmMEU9BjsARg%3D%3D--70268cd7008c6a0663aa263549cf6cc8bbadf362; domain=prosperworks.com; path=/; expires=Wed, 06-Jun-2018 22:22:46 GMT; secure; HttpOnly Status: schema: type: string example: 200 OK Vary: schema: type: string example: Accept-Encoding Via: schema: type: string example: 1.1 vegur X-Frame-Options: schema: type: string example: SAMEORIGIN X-Rack-Cors: schema: type: string example: preflight-hit; no-origin X-Request-Id: schema: type: string example: df1af169-2c9d-4264-acbb-c48896097acc X-Runtime: schema: type: string example: '0.092090' X-Ua-Compatible: schema: type: string example: IE=Edge,chrome=1 content: application/json: schema: $ref: '#/components/schemas/WebhooksViewSubscriptionByIdResponse' examples: See Webhook by ID: value: created_at: 1496787761 event: update id: 25347 secret: key: copper_notifications secret: hook_source target: https://your.endpoint.here type: person components: schemas: 1AccountAndUsersSearchUsersRequest: type: object properties: page_size: type: number example: 200 2LeadsUpdateLeadRequest: type: object properties: custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 184997 value: type: array items: type: number example: 262644 example: - 262644 - 262645 example: - custom_field_definition_id: 184997 value: - 262644 - 262645 details: type: string example: This is an update 2LeadsCreateNewLeadRequest: type: object properties: custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 100764 value: type: string example: Text fields are 255 chars or less! example: - custom_field_definition_id: 100764 value: Text fields are 255 chars or less! - custom_field_definition_id: 103481 value: Text area fields can have long text content customer_source_id: type: number example: 331242 email: type: object properties: category: type: string example: work email: type: string example: mylead@noemail.com name: type: string example: My Lead phone_numbers: type: array items: type: object properties: category: type: string example: mobile number: type: string example: 415-123-45678 example: - category: mobile number: 415-123-45678 2LeadsUpsertLeadRequest: type: object properties: match: type: object properties: field_name: type: string example: custom field_value: type: object properties: custom_field_definition_id: type: number example: 178384 value: type: number example: 1 properties: type: object properties: email: type: object properties: category: type: string example: work email: type: string example: mylead@gmail.test name: type: string example: My Lead 2LeadsConvertLeadToPersonRequest: type: object properties: details: type: object properties: opportunity: type: object properties: monetary_value: type: number example: 1000 name: type: string example: Demo Project pipeline_id: type: number example: 213214 pipeline_stage_id: type: number example: 12345 person: type: object properties: name: type: string example: John Doe 2LeadsListLeadsSearchRequest: type: object properties: maximum_interaction_date: type: number example: 1515797000 minimum_interaction_date: type: number example: 1515796000 page_size: type: number example: 25 sort_by: type: string example: name 2LeadsGetLeadActivitiesRequest: type: object properties: activity_types: type: array items: type: object properties: category: type: string example: user id: type: number example: 1 example: - category: user id: 1 3PeopleUpdatePersonByIdRequest: type: object properties: details: type: string example: This is an update 3PeopleGetByEmailRequest: type: object properties: email: type: string example: mycontact_123@noemail.com 3PeopleCreateNewPersonRequest: type: object properties: emails: type: array items: type: object properties: category: type: string example: work email: type: string example: mycontact_1233@noemail.com example: - category: work email: mycontact_1233@noemail.com name: type: string example: My Contact phone_numbers: type: array items: type: object properties: category: type: string example: mobile number: type: string example: 415-123-45678 example: - category: mobile number: 415-123-45678 3PeopleListPeopleSearchRequest: type: object properties: page_size: type: number example: 25 phone_number: type: string example: '4153554776' sort_by: type: string example: name 3PeopleGetPersonActivitiesRequest: type: object properties: activity_types: type: array items: type: object properties: category: type: string example: user id: type: number example: 1 example: - category: user id: 1 4CompaniesUpdateCompanyRequest: type: object properties: details: type: string example: This is an update 4CompaniesCreateNewCompanyRequest: type: object properties: address: type: object properties: city: type: string example: San Francisco postal_code: type: string example: '94105' state: type: string example: CA street: type: string example: 123 Main St details: type: string example: This is a demo company email_domain: type: string example: democompany.com name: type: string example: Demo Company phone_numbers: type: array items: type: object properties: category: type: string example: work number: type: string example: 415-123-45678 example: - category: work number: 415-123-45678 4CompaniesListCompanySearchRequest: type: object properties: contact_type_ids: type: array items: type: number example: 6 example: - 6 page_size: type: number example: 25 sort_by: type: string example: name 4CompaniesGetCompanyActivitiesRequest: type: object properties: activity_types: type: array items: type: object properties: category: type: string example: user id: type: number example: 1 example: - category: user id: 1 5OpportunitiesUpdateOpportunityFieldsRequest: type: object properties: details: type: string example: This is an update 5OpportunitiesCreateNewOpportunityRequest: type: object properties: customer_source_id: type: number example: 331242 name: type: string example: New Demo Opportunity primary_contact_id: type: number example: 27140359 5OpportunitiesListByCriteriaRequest: type: object properties: name: type: string example: 500 Keyboards (sample) 6ProjectsUpdateProjectRequest: type: object properties: details: type: string example: This is an update 6ProjectsCreateNewProjectRequest: type: object properties: name: type: string example: New Demo Project 6ProjectsListProjectsSearchRequest: type: object properties: custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 12 option: type: string example: ANY value: type: array items: type: number example: 8 example: - 8 example: - custom_field_definition_id: 12 option: ANY value: - 8 page_size: type: number example: 25 sort_by: type: string example: name 7TasksUpdateTaskRecordRequest: type: object properties: details: type: string example: This is an update 7TasksCreateNewTaskRequest: type: object properties: name: type: string example: Demo Task 7TasksListTasksSearchRequest: type: object properties: page_size: type: number example: 25 sort_by: type: string example: name statuses: type: array items: type: string example: Completed example: - Completed 8ActivitiesCreateNewActivityRequest: type: object properties: details: type: string example: This is the description of this note parent: type: object properties: id: type: number example: 27140359 type: type: string example: person type: type: object properties: category: type: string example: user id: type: number example: 0 8ActivitiesListSearchRequest: type: object properties: page_size: type: number example: 25 CustomFieldsCreateFieldDefinitionRequest: type: object properties: available_on: type: array items: type: string example: lead example: - lead - person data_type: type: string example: String name: type: string example: A String CustomFieldsUpdateExistingDefinitionRequest: type: object properties: name: type: string example: Renamed String CustomFieldsSearchEntityByCustomFieldRequest: type: object properties: custom_fields: type: array items: type: object properties: allow_empty: type: boolean example: true custom_field_definition_id: type: number example: 3 example: - allow_empty: true custom_field_definition_id: 3 CustomFieldsCreateCustomActivityTypeRequest: type: object properties: icon_type: type: string example: Phone name: type: string example: New Activity CustomFieldsUpdateExistingActivityTypeRequest: type: object properties: icon_type: type: string example: Todo CustomFieldsCreateConnectionRequest: type: object properties: custom_field_definition_id: type: number example: 169 source: type: object properties: entity_type: type: string example: lead id: type: number example: 1001 target: type: object properties: entity_type: type: string example: lead id: type: number example: 1002 FileUploadRelateToEntityRequest: type: object properties: file_name: type: string example: cat.jpeg key: type: string example: >- temp_uploads/f0317718-9b56-4d28-bda4-985af6b75f56/b0c5afe5-3d87-495d-ae58-760fcafbadec WebhooksUploadFileToS3Request: type: object properties: AWSAccessKeyId: type: string example: AKIAJNSZAC7M6FS6F3KQ acl: type: string example: private file: type: string example: /Users/username/Desktop/cat.jpeg key: type: string example: >- temp_uploads/f0317718-9b56-4d28-bda4-985af6b75f56/b0c5afe5-3d87-495d-ae58-760fcafbadec policy: type: string example: >- eyJleHBpcmF0aW9uIjoiMjAxOS0wNi0xMFQyMjoyMTo1OC4wMDBaIiwiY29uZGl0aW9ucyI6W3siYnVja2V0IjoiYWxpLXVzZXJhc3NldHMtcHJvZHVjdGlvbiJ9LHsiYWNsIjoicHJpdmF0ZSJ9LHsia2V5IjoidGVtcF91cGxvYWRzL2YwMzE3NzE4LTliNTYtNGQyOC1iZGE0LTk4NWFmNmI3NWY1Ni9iMGM1YWZlNS0zZDg3LTQ5NWQtYWU1OC03NjBmY2FmYmFkZWMifSxbImNvbnRlbnQtbGVuZ3RoLXJhbmdlIiwwLDEwNzM3NDE4MjRdLHsic3VjY2Vzc19hY3Rpb25fc3RhdHVzIjoiMjAxIn1dfQ== signature: type: string example: mxw/zFUbSmtKFWbxcfKQZRSmax4= success_action_status: type: string example: '201' WebhooksCreateSubscriptionEventRequest: type: object properties: event: type: string example: update secret: type: object properties: key: type: string example: copper_notifications secret: type: string example: hook_source target: type: string example: https://your.endpoint.here type: type: string example: lead 1AccountAndUsersGetDetailsResponse: type: object properties: id: type: number example: 100624 name: type: string example: Dev API Sandbox 1AccountAndUsersGetUserByIdResponse: type: object properties: email: type: string example: ehdb@phpbb.uu.gl id: type: number example: 159258 name: type: string example: Demo User 1AccountAndUsersSearchUsersResponse: type: array items: type: object properties: email: type: string example: johndoe@copper.com id: type: number example: 137658 name: type: string example: John Doe example: - email: johndoe@copper.com id: 137658 name: John Doe - email: janesmith@copper.com id: 159258 name: Jane Smith 2LeadsRemoveLeadResponse: type: object properties: id: type: number example: 8900677 is_deleted: type: boolean example: true 2LeadsGetLeadByIdResponse: type: object properties: tags: type: array items: type: string example: tag 1 example: - tag 1 - tag 2 title: type: string example: Title address: type: object properties: city: type: string example: San Francisco country: type: string example: US postal_code: type: string example: '94105' state: type: string example: CA street: type: string example: 301 Howard St Ste 600 assignee_id: type: number example: 137658 company_name: type: string example: Lead's Company custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 100764 value: nullable: true example: null example: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null customer_source_id: type: number example: 331241 date_created: type: number example: 1489018784 date_modified: type: number example: 1489173601 details: type: string example: This is a demo description email: type: object properties: category: type: string example: work email: type: string example: address@workemail.com first_name: type: string example: Test id: type: number example: 8894157 last_name: type: string example: Lead middle_name: nullable: true example: null monetary_value: type: number example: 100 name: type: string example: Test Lead phone_numbers: type: array items: type: object properties: category: type: string example: mobile number: type: string example: 415-999-4321 example: - category: mobile number: 415-999-4321 - category: work number: 415-555-1234 prefix: nullable: true example: null socials: type: array items: type: object properties: category: type: string example: facebook url: type: string example: facebook.com/test_lead example: - category: facebook url: facebook.com/test_lead status: type: string example: New status_id: type: number example: 208231 suffix: nullable: true example: null websites: type: array items: type: object properties: category: type: string example: work url: type: string example: www.workwebsite.com example: - category: work url: www.workwebsite.com 2LeadsUpdateLeadResponse: type: object properties: tags: type: array items: type: string example: tag 1 example: - tag 1 - tag 2 title: type: string example: Title address: type: object properties: city: type: string example: San Francisco country: type: string example: US postal_code: type: string example: '94105' state: type: string example: CA street: type: string example: 301 Howard St Ste 600 assignee_id: type: number example: 137658 company_name: type: string example: Lead's Company custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 100764 value: nullable: true example: A Text Value anyOf: - type: string example: A Text Value - type: number example: 1511942400 - type: array items: type: number example: 262644 example: - 262644 - 262645 - nullable: true example: null example: - custom_field_definition_id: 100764 value: A Text Value - custom_field_definition_id: 128735 value: 1511942400 - custom_field_definition_id: 184997 value: - 262644 - 262645 - custom_field_definition_id: 103481 value: null customer_source_id: type: number example: 331241 date_created: type: number example: 1489018784 date_last_contacted: nullable: true example: null date_modified: type: number example: 1513976942 details: type: string example: This is an update email: type: object properties: category: type: string example: work email: type: string example: address@workemail.com first_name: type: string example: Test id: type: number example: 8894157 interaction_count: type: number example: 0 last_name: type: string example: Lead middle_name: nullable: true example: null monetary_unit: nullable: true example: null monetary_value: type: number example: 100 name: type: string example: Test Lead phone_numbers: type: array items: type: object properties: category: type: string example: mobile number: type: string example: 415-999-4321 example: - category: mobile number: 415-999-4321 - category: work number: 415-555-1234 prefix: nullable: true example: null socials: type: array items: type: object properties: category: type: string example: facebook url: type: string example: facebook.com/test_lead example: - category: facebook url: facebook.com/test_lead status: type: string example: New status_id: type: number example: 208231 suffix: nullable: true example: null websites: type: array items: type: object properties: category: type: string example: work url: type: string example: www.workwebsite.com example: - category: work url: www.workwebsite.com 2LeadsCreateNewLeadResponse: type: object properties: tags: type: array items: {} example: [] title: nullable: true example: null address: nullable: true example: null assignee_id: nullable: true example: null company_name: nullable: true example: null custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 100764 value: type: string nullable: true example: Text fields are 255 chars or less! example: - custom_field_definition_id: 100764 value: Text fields are 255 chars or less! - custom_field_definition_id: 103481 value: Text area fields can have long text content - custom_field_definition_id: 128735 value: null customer_source_id: type: number example: 331242 date_created: type: number example: 1502158444 date_last_contacted: nullable: true example: null date_modified: type: number example: 1502158444 details: nullable: true example: null email: type: object properties: category: type: string example: work email: type: string example: mylead@noemail.com first_name: type: string example: My id: type: number example: 13244480 interaction_count: type: number example: 0 last_name: type: string example: Lead middle_name: nullable: true example: null monetary_value: nullable: true example: null name: type: string example: My Lead phone_numbers: type: array items: type: object properties: category: type: string example: mobile number: type: string example: 415-123-45678 example: - category: mobile number: 415-123-45678 prefix: nullable: true example: null socials: type: array items: {} example: [] status: type: string example: New status_id: type: number example: 208231 suffix: nullable: true example: null websites: type: array items: {} example: [] 2LeadsUpsertLeadResponse: type: object properties: tags: type: array items: {} example: [] title: nullable: true example: null address: nullable: true example: null assignee_id: nullable: true example: null company_name: nullable: true example: null custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 100764 value: nullable: true example: null example: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null - custom_field_definition_id: 128735 value: null customer_source_id: nullable: true example: null date_created: type: number example: 1489531171 date_last_contacted: nullable: true example: null date_modified: type: number example: 1512006056 details: nullable: true example: null email: type: object properties: category: type: string example: work email: type: string example: mylead@gmail.test first_name: type: string example: My id: type: number example: 8982702 interaction_count: type: number example: 0 last_name: type: string example: Lead middle_name: nullable: true example: null monetary_unit: nullable: true example: null monetary_value: nullable: true example: null name: type: string example: My Lead phone_numbers: type: array items: {} example: [] prefix: nullable: true example: null socials: type: array items: {} example: [] status: type: string example: New status_id: type: number example: 208231 suffix: nullable: true example: null websites: type: array items: {} example: [] 2LeadsConvertLeadToPersonResponse: type: object properties: company: type: object properties: tags: type: array items: {} example: [] address: nullable: true example: null assignee_id: type: number example: 137658 contact_type_id: type: number example: 451490 custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 100764 value: type: string example: Text fields are 255 chars or less! example: - custom_field_definition_id: 100764 value: Text fields are 255 chars or less! - custom_field_definition_id: 103481 value: Text area fields can have long text content date_created: type: number example: 1496694264 date_modified: type: number example: 1496694264 details: nullable: true example: null email_domain: type: string example: noemail.com id: type: number example: 13349319 interaction_count: type: number example: 0 name: type: string example: Noemail phone_numbers: type: array items: {} example: [] socials: type: array items: {} example: [] websites: type: array items: {} example: [] opportunity: type: object properties: tags: type: array items: {} example: [] assignee_id: nullable: true example: null close_date: nullable: true example: null company_id: type: number example: 13349319 company_name: type: string example: Noemail custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 100764 value: type: string example: Text fields are 255 chars or less! example: - custom_field_definition_id: 100764 value: Text fields are 255 chars or less! - custom_field_definition_id: 103481 value: Text area fields can have long text content customer_source_id: nullable: true example: null date_created: type: number example: 1496694264 date_modified: type: number example: 1496694264 details: type: string example: '' id: type: number example: 4417020 interaction_count: type: number example: 0 loss_reason_id: nullable: true example: null monetary_value: type: number example: 1000 name: type: string example: Demo Project pipeline_id: type: number example: 213214 pipeline_stage_id: type: number example: 987790 primary_contact_id: type: number example: 27140359 priority: nullable: true example: null status: type: string example: Open win_probability: type: number example: 0 person: type: object properties: tags: type: array items: {} example: [] title: nullable: true example: null address: nullable: true example: null assignee_id: nullable: true example: null company_id: type: number example: 13349319 company_name: type: string example: Noemail contact_type_id: type: number example: 451492 custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 100764 value: type: string example: Text fields are 255 chars or less! example: - custom_field_definition_id: 100764 value: Text fields are 255 chars or less! - custom_field_definition_id: 103481 value: Text area fields can have long text content date_created: type: number example: 1490045010 date_modified: type: number example: 1496694264 details: nullable: true example: null emails: type: array items: type: object properties: category: type: string example: work email: type: string example: mylead@noemail.com example: - category: work email: mylead@noemail.com first_name: type: string example: My id: type: number example: 27140359 interaction_count: type: number example: 0 last_name: type: string example: Contact middle_name: nullable: true example: null name: type: string example: My Contact phone_numbers: type: array items: {} example: [] prefix: nullable: true example: null socials: type: array items: {} example: [] suffix: nullable: true example: null websites: type: array items: {} example: [] 2LeadsListLeadsSearchResponse: type: array items: type: object properties: tags: type: array items: {} example: [] title: type: string example: Manager address: type: object properties: city: type: string example: Philadelphia country: type: string example: US postal_code: type: string example: '18503' state: type: string example: PA street: type: string example: 213 West Main St nullable: true assignee_id: type: number nullable: true example: 2 company_name: type: string example: Dunder Mifflin, Inc. custom_fields: type: array items: {} example: [] customer_source_id: type: number example: 4 date_created: type: number example: 1515434872 date_last_contacted: nullable: true example: null date_modified: type: number example: 1515786833 details: type: string example: This is an update email: type: object properties: category: type: string example: work email: type: string example: jim@dundermifflin.com first_name: type: string example: Jim Halpert (sample2) id: type: number example: 6 interaction_count: type: number example: 0 last_name: nullable: true example: null middle_name: nullable: true example: null monetary_unit: nullable: true example: null monetary_value: type: number example: 2500 name: type: string example: Jim Halpert (sample2) phone_numbers: type: array items: type: object properties: category: type: string example: work number: type: string example: '5104447778' example: - category: work number: '5104447778' prefix: nullable: true example: null socials: type: array items: {} example: [] status: type: string example: New status_id: type: number example: 5 suffix: nullable: true example: null websites: type: array items: type: object properties: category: type: string example: work url: type: string example: http://www.dundermifflin.com example: - category: work url: http://www.dundermifflin.com example: - tags: [] title: Manager address: city: Philadelphia country: US postal_code: '18503' state: PA street: 213 West Main St assignee_id: 2 company_name: Dunder Mifflin, Inc. custom_fields: [] customer_source_id: 4 date_created: 1515434872 date_last_contacted: null date_modified: 1515786833 details: This is an update email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample2) id: 6 interaction_count: 0 last_name: null middle_name: null monetary_unit: null monetary_value: 2500 name: Jim Halpert (sample2) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 5 suffix: null websites: - category: work url: http://www.dundermifflin.com - tags: - sample title: Office Coordinator address: null assignee_id: null company_name: Dunder Mifflin, Inc. custom_fields: [] customer_source_id: 4 date_created: 1515434872 date_last_contacted: null date_modified: 1515525131 details: >- A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity. Once your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works! email: category: work email: pam@dundermifflin.com first_name: Pam Beesly (sample) id: 5 interaction_count: 0 last_name: null middle_name: null monetary_unit: null monetary_value: 5000 name: Pam Beesly (sample) phone_numbers: - category: work number: '5105553333' prefix: null socials: [] status: Unqualified status_id: 7 suffix: null websites: - category: work url: http://www.dundermifflin.com 2LeadsGetLeadActivitiesResponse: type: array items: type: object properties: activity_date: type: number example: 1522455323 date_created: type: number example: 1522455329 date_modified: type: number example: 1522455323 details: type: string example: Phone call with Dave id: type: number example: 68 new_value: nullable: true example: null old_value: nullable: true example: null parent: type: object properties: id: type: number example: 1 type: type: string example: lead type: type: object properties: category: type: string example: user id: type: number example: 1 user_id: type: number example: 1 example: - activity_date: 1522455323 date_created: 1522455329 date_modified: 1522455323 details: Phone call with Dave id: 68 new_value: null old_value: null parent: id: 1 type: lead type: category: user id: 1 user_id: 1 5OpportunitiesListCustomerSourcesResponse: type: array items: type: object properties: id: type: number example: 331240 name: type: string example: Email example: - id: 331240 name: Email - id: 331241 name: Cold Call - id: 331242 name: Advertising 2LeadsListLeadStatusesResponse: type: array items: type: object properties: id: type: number example: 208231 is_default: type: boolean example: true name: type: string example: New order: type: number example: 1 example: - id: 208231 is_default: true name: New order: 1 - id: 208232 is_default: false name: Open order: 2 - id: 208233 is_default: false name: Unqualified order: 3 - id: 208234 is_default: false name: Junk order: 4 3PeopleRemovePersonResponse: type: object properties: id: type: number example: 26443553 is_deleted: type: boolean example: true 3PeopleUpdatePersonByIdResponse: type: object properties: tags: type: array items: {} example: [] title: nullable: true example: null address: type: object properties: city: type: string example: '' country: type: string example: '' postal_code: type: string example: '' state: type: string example: '' street: type: string example: '' assignee_id: type: number example: 137658 company_id: nullable: true example: null company_name: nullable: true example: null contact_type_id: type: number example: 451490 custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 100764 value: nullable: true example: null example: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: type: number example: 1489018908 date_modified: type: number example: 1496699863 details: type: string example: This is an update emails: type: array items: {} example: [] first_name: type: string example: Person id: type: number example: 26443553 interaction_count: type: number example: 0 last_name: type: string example: Default middle_name: nullable: true example: null name: type: string example: Person Default phone_numbers: type: array items: {} example: [] prefix: nullable: true example: null socials: type: array items: {} example: [] suffix: nullable: true example: null websites: type: array items: {} example: [] 3PeopleGetByEmailResponse: type: object properties: tags: type: array items: {} example: [] title: nullable: true example: null address: nullable: true example: null assignee_id: nullable: true example: null company_id: nullable: true example: null company_name: nullable: true example: null contact_type_id: type: number example: 451492 custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 100764 value: nullable: true example: null example: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: type: number example: 1490045413 date_modified: type: number example: 1490045413 details: nullable: true example: null emails: type: array items: type: object properties: category: type: string example: work email: type: string example: mycontact_123@noemail.com example: - category: work email: mycontact_123@noemail.com first_name: type: string example: My id: type: number example: 27140442 interaction_count: type: number example: 0 last_name: type: string example: Contact middle_name: nullable: true example: null name: type: string example: My Contact phone_numbers: type: array items: type: object properties: category: type: string example: mobile number: type: string example: 415-123-45678 example: - category: mobile number: 415-123-45678 prefix: nullable: true example: null socials: type: array items: {} example: [] suffix: nullable: true example: null websites: type: array items: {} example: [] 3PeopleCreateNewPersonResponse: type: object properties: tags: type: array items: {} example: [] title: nullable: true example: null address: nullable: true example: null assignee_id: nullable: true example: null company_id: nullable: true example: null company_name: nullable: true example: null contact_type_id: type: number example: 451492 custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 100764 value: nullable: true example: null example: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: type: number example: 1490045450 date_modified: type: number example: 1490045450 details: nullable: true example: null emails: type: array items: type: object properties: category: type: string example: work email: type: string example: mycontact_1233@noemail.com example: - category: work email: mycontact_1233@noemail.com first_name: type: string example: My id: type: number example: 27140448 last_name: type: string example: Contact middle_name: nullable: true example: null name: type: string example: My Contact phone_numbers: type: array items: type: object properties: category: type: string example: mobile number: type: string example: 415-123-45678 example: - category: mobile number: 415-123-45678 prefix: nullable: true example: null socials: type: array items: {} example: [] suffix: nullable: true example: null websites: type: array items: {} example: [] 3PeopleListPeopleSearchResponse: type: array items: type: object properties: tags: type: array items: {} example: [] title: type: string example: CEO address: type: object properties: city: type: string example: Philadelphia country: type: string example: '' postal_code: type: string example: '19135' state: type: string example: PA street: type: string example: 543 Washington Ave assignee_id: nullable: true example: null company_id: type: number example: 4 company_name: type: string example: Sabre Inc (sample) contact_type_id: type: number example: 5 custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 8 value: nullable: true example: null anyOf: - type: boolean nullable: true example: true - type: array items: {} example: [] - nullable: true example: null - nullable: true example: null - nullable: true example: null example: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: type: number example: 1515434865 date_last_contacted: nullable: true example: null date_lead_created: nullable: true example: null date_modified: type: number example: 1515525462 details: nullable: true example: null emails: type: array items: type: object properties: category: type: string example: work email: type: string example: jo@sabreinc.com example: - category: work email: jo@sabreinc.com first_name: type: string example: Jo id: type: number example: 6 interaction_count: type: number example: 0 last_name: type: string example: Bennett leads_converted_from: type: array items: {} example: [] middle_name: nullable: true example: null name: type: string example: Jo Bennett, (sample) phone_numbers: type: array items: {} example: [] prefix: nullable: true example: null socials: type: array items: {} example: [] suffix: type: string example: (sample) websites: type: array items: {} example: [] example: - tags: [] title: CEO address: city: Philadelphia country: '' postal_code: '19135' state: PA street: 543 Washington Ave assignee_id: null company_id: 4 company_name: Sabre Inc (sample) contact_type_id: 5 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434865 date_last_contacted: null date_lead_created: null date_modified: 1515525462 details: null emails: - category: work email: jo@sabreinc.com first_name: Jo id: 6 interaction_count: 0 last_name: Bennett leads_converted_from: [] middle_name: null name: Jo Bennett, (sample) phone_numbers: [] prefix: null socials: [] suffix: (sample) websites: [] - tags: [] title: Regional Manager address: city: Scranton country: '' postal_code: '18501' state: PA street: 213 West Main Street assignee_id: null company_id: 3 company_name: Dunder Mifflin (sample) contact_type_id: 5 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434864 date_last_contacted: null date_lead_created: null date_modified: 1515434877 details: null emails: - category: work email: michael@dundermifflin.com first_name: Michael id: 5 interaction_count: 0 last_name: Scott leads_converted_from: [] middle_name: null name: Michael Scott, (sample) phone_numbers: - category: work number: '4152225466' prefix: null socials: [] suffix: (sample) websites: - category: work url: http://www.dundermifflin.com/index.shtml 3PeopleGetPersonActivitiesResponse: type: array items: type: object properties: activity_date: type: number example: 1522694372 date_created: type: number example: 1522694392 date_modified: type: number example: 1522694372 details: type: string example: Call with Rob id: type: number example: 70 new_value: nullable: true example: null old_value: nullable: true example: null parent: type: object properties: id: type: number example: 2 type: type: string example: person type: type: object properties: category: type: string example: user id: type: number example: 1 user_id: type: number example: 1 example: - activity_date: 1522694372 date_created: 1522694392 date_modified: 1522694372 details: Call with Rob id: 70 new_value: null old_value: null parent: id: 2 type: person type: category: user id: 1 user_id: 1 4CompaniesListContactTypesResponse: type: array items: type: object properties: id: type: number example: 451490 name: type: string example: Potential Customer example: - id: 451490 name: Potential Customer - id: 451491 name: Current Customer - id: 451492 name: Uncategorized - id: 451493 name: Other 4CompaniesGetByIdResponse: type: object properties: tags: type: array items: {} example: [] address: type: object properties: city: type: string example: Scranton country: type: string example: '' postal_code: type: string example: '18501' state: type: string example: PA street: type: string example: 213 West Main Street assignee_id: nullable: true example: null contact_type_id: nullable: true example: null custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 100764 value: nullable: true example: null example: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: type: number example: 1483988828 date_modified: type: number example: 1489018922 details: type: string example: >- Keywords: Dunder Mifflin, Dunder Mifflin Infinity, Dunder Mifflin Paper, Dunder Mifflin Scranton, Dunder-mifflin, Dunder-mifflin Paper, Dunder-mifflin Scranton, Dundermifflin, NBC, NBC.com, Office 360, Ryan Howard, Scranton Office Supplies, The Office 360, The Office Tv, The Office Tv Series, The Office Tv Show email_domain: type: string example: dundermifflin.com id: type: number example: 9607580 interaction_count: type: number example: 0 name: type: string example: Dunder Mifflin (sample) phone_numbers: type: array items: type: object properties: category: type: string example: work number: type: string example: '4153554776' example: - category: work number: '4153554776' socials: type: array items: {} example: [] websites: type: array items: type: object properties: category: type: string example: work url: type: string example: http://www.dundermifflin.com/index.shtml example: - category: work url: http://www.dundermifflin.com/index.shtml - category: work url: >- https://www.nbcstore.com/shop-by-show/the-office.html?shop_by_theme=7 - category: work url: http://dundermifflin.com 4CompaniesUpdateCompanyResponse: type: object properties: tags: type: array items: {} example: [] address: type: object properties: city: type: string example: Scranton country: type: string example: '' postal_code: type: string example: '18501' state: type: string example: PA street: type: string example: 213 West Main Street assignee_id: nullable: true example: null contact_type_id: nullable: true example: null custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 100764 value: nullable: true example: null example: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: type: number example: 1483988828 date_modified: type: number example: 1496708712 details: type: string example: This is an update email_domain: type: string example: dundermifflin.com id: type: number example: 9607580 interaction_count: type: number example: 0 name: type: string example: Dunder Mifflin (sample) phone_numbers: type: array items: type: object properties: category: type: string example: work number: type: string example: '4153554776' example: - category: work number: '4153554776' socials: type: array items: {} example: [] websites: type: array items: type: object properties: category: type: string example: work url: type: string example: http://www.dundermifflin.com/index.shtml example: - category: work url: http://www.dundermifflin.com/index.shtml - category: work url: >- https://www.nbcstore.com/shop-by-show/the-office.html?shop_by_theme=7 - category: work url: http://dundermifflin.com 4CompaniesCreateNewCompanyResponse: type: object properties: tags: type: array items: {} example: [] address: type: object properties: city: type: string example: San Francisco country: nullable: true example: null postal_code: type: string example: '94105' state: type: string example: CA street: type: string example: 123 Main St assignee_id: nullable: true example: null contact_type_id: nullable: true example: null custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 100764 value: nullable: true example: null example: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: type: number example: 1496707930 date_modified: type: number example: 1496707930 details: type: string example: This is a demo company email_domain: type: string example: democompany.com id: type: number example: 13358412 interaction_count: type: number example: 0 name: type: string example: Demo Company phone_numbers: type: array items: type: object properties: category: type: string example: work number: type: string example: 415-123-45678 example: - category: work number: 415-123-45678 socials: type: array items: {} example: [] websites: type: array items: {} example: [] 4CompaniesRemoveCompanyResponse: type: object properties: id: type: number example: 26443553 is_deleted: type: boolean example: true 4CompaniesListCompanySearchResponse: type: array items: type: object properties: tags: type: array items: {} example: [] address: type: object properties: city: type: string example: Scranton country: nullable: true example: null postal_code: type: string example: '18501' state: type: string example: PA street: type: string example: 213 West Main Street assignee_id: nullable: true example: null contact_type_id: nullable: true example: null custom_fields: type: array items: {} example: [] date_created: type: number example: 1519852352 date_modified: type: number example: 1519852398 details: nullable: true example: null email_domain: type: string example: dundermifflin.com id: type: number example: 2 interaction_count: type: number example: 0 name: type: string example: Dunder Mifflin (sample) phone_numbers: type: array items: type: object properties: category: type: string example: work number: type: string example: '4153554776' example: - category: work number: '4153554776' socials: type: array items: {} example: [] websites: type: array items: type: object properties: category: type: string example: work url: type: string example: http://www.dundermifflin.com/index.shtml example: - category: work url: http://www.dundermifflin.com/index.shtml example: - tags: [] address: city: Scranton country: null postal_code: '18501' state: PA street: 213 West Main Street assignee_id: null contact_type_id: null custom_fields: [] date_created: 1519852352 date_modified: 1519852398 details: null email_domain: dundermifflin.com id: 2 interaction_count: 0 name: Dunder Mifflin (sample) phone_numbers: - category: work number: '4153554776' socials: [] websites: - category: work url: http://www.dundermifflin.com/index.shtml 4CompaniesGetCompanyActivitiesResponse: type: array items: type: object properties: activity_date: type: number example: 1522695004 date_created: type: number example: 1522695010 date_modified: type: number example: 1522695004 details: type: string example: Call with Alex id: type: number example: 72 new_value: nullable: true example: null old_value: nullable: true example: null parent: type: object properties: id: type: number example: 1 type: type: string example: company type: type: object properties: category: type: string example: user id: type: number example: 1 user_id: type: number example: 1 example: - activity_date: 1522695004 date_created: 1522695010 date_modified: 1522695004 details: Call with Alex id: 72 new_value: null old_value: null parent: id: 1 type: company type: category: user id: 1 user_id: 1 - activity_date: 1522694372 date_created: 1522694392 date_modified: 1522694372 details: Call with Rob id: 70 new_value: null old_value: null parent: id: 2 type: person type: category: user id: 1 user_id: 1 5OpportunitiesGetOpportunityByIdResponse: type: object properties: tags: type: array items: {} example: [] assignee_id: nullable: true example: null close_date: type: string example: 1/23/2017 company_id: type: number example: 9607580 company_name: type: string example: Dunder Mifflin (sample) custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 100764 value: nullable: true example: null example: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null customer_source_id: type: number example: 331241 date_created: type: number example: 1483988829 date_modified: type: number example: 1489018922 details: type: string example: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: type: number example: 2827698 interaction_count: type: number example: 0 loss_reason_id: nullable: true example: null monetary_value: type: number example: 250000 name: type: string example: 8 New Copy Machines (sample) pipeline_id: type: number example: 213214 pipeline_stage_id: type: number example: 987790 primary_contact_id: nullable: true example: null priority: type: string example: None status: type: string example: Open win_probability: type: number example: 5 5OpportunitiesUpdateOpportunityFieldsResponse: type: object properties: tags: type: array items: {} example: [] assignee_id: nullable: true example: null close_date: type: string example: 1/23/2017 company_id: type: number example: 9607580 company_name: type: string example: Dunder Mifflin (sample) custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 100764 value: nullable: true example: null example: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null customer_source_id: type: number example: 331241 date_created: type: number example: 1483988829 date_modified: type: number example: 1496776255 details: type: string example: This is an update id: type: number example: 2827698 interaction_count: type: number example: 0 loss_reason_id: nullable: true example: null monetary_value: type: number example: 250000 name: type: string example: 8 New Copy Machines (sample) pipeline_id: type: number example: 213214 pipeline_stage_id: type: number example: 987790 primary_contact_id: nullable: true example: null priority: type: string example: None status: type: string example: Open win_probability: type: number example: 5 5OpportunitiesCreateNewOpportunityResponse: type: object properties: tags: type: array items: {} example: [] assignee_id: nullable: true example: null close_date: nullable: true example: null company_id: type: number example: 13349319 company_name: type: string example: Noemail custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 126240 value: nullable: true example: null example: - custom_field_definition_id: 126240 value: null - custom_field_definition_id: 103481 value: null - custom_field_definition_id: 100764 value: null customer_source_id: type: number example: 331242 date_created: type: number example: 1502158599 date_last_contacted: nullable: true example: null date_modified: type: number example: 1502158599 details: nullable: true example: null id: type: number example: 4956209 interaction_count: type: number example: 0 leads_converted_from: type: array items: {} example: [] loss_reason_id: nullable: true example: null monetary_value: nullable: true example: null name: type: string example: New Demo Opportunity pipeline_id: type: number example: 213214 pipeline_stage_id: type: number example: 987790 primary_contact_id: type: number example: 27140359 priority: type: string example: None status: type: string example: Open win_probability: type: number example: 5 5OpportunitiesRemoveOpportunityRecordResponse: type: object properties: id: type: number example: 99999999 is_deleted: type: boolean example: true 5OpportunitiesListByCriteriaResponse: type: array items: type: object properties: tags: type: array items: type: string example: tag1 example: - tag1 assignee_id: nullable: true example: null close_date: type: string example: 1/13/2018 company_id: type: number example: 4 company_name: type: string example: Sabre Inc (sample) custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 5 value: nullable: true example: 6 anyOf: - type: number example: 6 - type: array items: type: number example: 8 example: - 8 - nullable: true example: null - nullable: true example: null - nullable: true example: null - type: boolean example: false - nullable: true example: null - nullable: true example: null - nullable: true example: null example: - custom_field_definition_id: 5 value: 6 - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null customer_source_id: nullable: true example: null date_created: type: number example: 1515434870 date_last_contacted: nullable: true example: null date_lead_created: nullable: true example: null date_modified: type: number example: 1516736568 date_stage_changed: type: number example: 1515434870 details: type: string example: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: type: number example: 5 interaction_count: type: number example: 0 leads_converted_from: type: array items: {} example: [] loss_reason_id: nullable: true example: null monetary_unit: type: string example: USD monetary_value: type: number example: 50000 name: type: string example: 500 Keyboards (sample) pipeline_id: type: number example: 3 pipeline_stage_id: type: number example: 11 primary_contact_id: type: number example: 3 priority: type: string example: None status: type: string example: Open win_probability: type: number example: 10 example: - tags: - tag1 assignee_id: null close_date: 1/13/2018 company_id: 4 company_name: Sabre Inc (sample) custom_fields: - custom_field_definition_id: 5 value: 6 - custom_field_definition_id: 6 value: 1515744000 - custom_field_definition_id: 12 value: - 8 - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 10 value: null customer_source_id: null date_created: 1515434870 date_last_contacted: null date_lead_created: null date_modified: 1516736568 date_stage_changed: 1515434870 details: >- Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. id: 5 interaction_count: 0 leads_converted_from: [] loss_reason_id: null monetary_unit: USD monetary_value: 50000 name: 500 Keyboards (sample) pipeline_id: 3 pipeline_stage_id: 11 primary_contact_id: 3 priority: None status: Open win_probability: 10 5OpportunitiesListLossReasonsResponse: type: array items: type: object properties: id: type: number example: 308806 name: type: string example: Price example: - id: 308806 name: Price - id: 308807 name: Features - id: 308808 name: Competitor 5OpportunitiesGetPipelinesListResponse: type: array items: type: object properties: id: type: number example: 213214 name: type: string example: Sales stages: type: array items: type: object properties: id: type: number example: 987790 name: type: string example: Qualified win_probability: type: number example: 5 example: - id: 987790 name: Qualified win_probability: 5 - id: 987791 name: Follow-up win_probability: 10 - id: 987792 name: Presentation win_probability: 20 - id: 987793 name: Contract Sent win_probability: 40 - id: 987794 name: Negotiation win_probability: 80 example: - id: 213214 name: Sales stages: - id: 987790 name: Qualified win_probability: 5 - id: 987791 name: Follow-up win_probability: 10 - id: 987792 name: Presentation win_probability: 20 - id: 987793 name: Contract Sent win_probability: 40 - id: 987794 name: Negotiation win_probability: 80 - id: 213215 name: Business Development stages: - id: 987795 name: First Meeting win_probability: 10 - id: 987796 name: Partner Meeting win_probability: 25 - id: 987797 name: Negotiation win_probability: 50 - id: 987798 name: Term Sheet win_probability: 75 5OpportunitiesListPipelineStagesResponse: type: array items: type: object properties: id: type: number example: 987790 name: type: string example: Qualified pipeline_id: type: number example: 213214 win_probability: type: number example: 5 example: - id: 987790 name: Qualified pipeline_id: 213214 win_probability: 5 - id: 987791 name: Follow-up pipeline_id: 213214 win_probability: 10 - id: 987792 name: Presentation pipeline_id: 213214 win_probability: 20 - id: 987793 name: Contract Sent pipeline_id: 213214 win_probability: 40 - id: 987794 name: Negotiation pipeline_id: 213214 win_probability: 80 - id: 987795 name: First Meeting pipeline_id: 213215 win_probability: 10 - id: 987796 name: Partner Meeting pipeline_id: 213215 win_probability: 25 - id: 987797 name: Negotiation pipeline_id: 213215 win_probability: 50 - id: 987798 name: Term Sheet pipeline_id: 213215 win_probability: 75 5OpportunitiesListPipelineStages200Response: type: array items: type: object properties: id: type: number example: 987790 name: type: string example: Qualified pipeline_id: type: number example: 213214 win_probability: type: number example: 5 example: - id: 987790 name: Qualified pipeline_id: 213214 win_probability: 5 - id: 987791 name: Follow-up pipeline_id: 213214 win_probability: 10 - id: 987792 name: Presentation pipeline_id: 213214 win_probability: 20 - id: 987793 name: Contract Sent pipeline_id: 213214 win_probability: 40 - id: 987794 name: Negotiation pipeline_id: 213214 win_probability: 80 6ProjectsGetByIdResponse: type: object properties: tags: type: array items: {} example: [] assignee_id: nullable: true example: null custom_fields: type: array items: {} example: [] date_created: type: number example: 1483988830 date_modified: type: number example: 1496712857 details: type: string example: >- Visit our settings section to discover all the ways you can customize Copper to fit your sales workflow. id: type: number example: 144296 name: type: string example: Customize Your New CRM related_resource: type: object properties: id: type: number example: 9607579 type: type: string example: company status: type: string example: Open 6ProjectsUpdateProjectResponse: type: object properties: tags: type: array items: {} example: [] assignee_id: nullable: true example: null custom_fields: type: array items: {} example: [] date_created: type: number example: 1483988830 date_modified: type: number example: 1496776314 details: type: string example: This is an update id: type: number example: 144296 name: type: string example: Customize Your New CRM related_resource: type: object properties: id: type: number example: 9607579 type: type: string example: company status: type: string example: Open 6ProjectsCreateNewProjectResponse: type: object properties: tags: type: array items: {} example: [] assignee_id: nullable: true example: null custom_fields: type: array items: {} example: [] date_created: type: number example: 1496713867 date_modified: type: number example: 1496713867 details: nullable: true example: null id: type: number example: 208105 name: type: string example: New Demo Project related_resource: nullable: true example: null status: type: string example: Open 6ProjectsRemoveProjectRecordResponse: type: object properties: id: type: number example: 99999999 is_deleted: type: boolean example: true 6ProjectsListProjectsSearchResponse: type: array items: type: object properties: tags: type: array items: {} example: [] address: type: object properties: city: type: string example: San Francisco country: type: string nullable: true example: null postal_code: type: string example: '94105' state: type: string example: CA street: type: string example: 123 Main St nullable: true assignee_id: type: number nullable: true example: null contact_type_id: type: number nullable: true example: null custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 100764 value: nullable: true example: null example: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: type: number example: 1496707930 date_modified: type: number example: 1496707932 details: type: string nullable: true example: This is a demo company email_domain: type: string nullable: true example: democompany.com id: type: number example: 13358412 interaction_count: type: number example: 0 name: type: string example: Demo Company phone_numbers: type: array items: type: object properties: category: type: string example: work number: type: string example: 415-123-45678 example: - category: work number: 415-123-45678 socials: type: array items: {} example: [] websites: type: array items: type: object properties: category: type: string example: work url: type: string example: http://democompany.com example: - category: work url: http://democompany.com example: - tags: [] address: city: San Francisco country: null postal_code: '94105' state: CA street: 123 Main St assignee_id: null contact_type_id: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1496707930 date_modified: 1496707932 details: This is a demo company email_domain: democompany.com id: 13358412 interaction_count: 0 name: Demo Company phone_numbers: - category: work number: 415-123-45678 socials: [] websites: - category: work url: http://democompany.com - tags: [] address: city: Scranton country: '' postal_code: '18501' state: PA street: 213 West Main Street assignee_id: null contact_type_id: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1483988828 date_modified: 1496710807 details: This is an update email_domain: dundermifflin.com id: 9607580 interaction_count: 2 name: Dunder Mifflin (sample) phone_numbers: - category: work number: '4153554776' socials: [] websites: - category: work url: http://www.dundermifflin.com/index.shtml - category: work url: >- https://www.nbcstore.com/shop-by-show/the-office.html?shop_by_theme=7 - category: work url: http://dundermifflin.com - tags: [] address: null assignee_id: null contact_type_id: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1496713616 date_modified: 1496713616 details: null email_domain: null id: 13362547 interaction_count: 0 name: New Demo Opportunity phone_numbers: [] socials: [] websites: [] - tags: [] address: null assignee_id: null contact_type_id: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1496713797 date_modified: 1496713797 details: null email_domain: null id: 13362760 interaction_count: 0 name: New Demo Project phone_numbers: [] socials: [] websites: [] - tags: [] address: null assignee_id: 137658 contact_type_id: 451490 custom_fields: - custom_field_definition_id: 100764 value: Text fields are 255 chars or less! - custom_field_definition_id: 103481 value: Text area fields can have long text content date_created: 1496694264 date_modified: 1496713841 details: null email_domain: noemail.com id: 13349319 interaction_count: 0 name: Noemail phone_numbers: [] socials: [] websites: [] - tags: [] address: city: San Francisco country: '' postal_code: '94105' state: CA street: 221 Main Street Suite 1350 assignee_id: null contact_type_id: 451493 custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1483988828 date_modified: 1489018922 details: >- Overview: ProsperWorks is the world's first zero input CRM. Designed specifically for Google Apps, ProsperWorks helps companies sell more faster by identifying, organizing and tracking sales opportunities right in Gmail, Calendar and Google Drive. By removing the need for data entry, salespeople can focus on developing business and managers can finally have accurate forecasting with real time activity tracking. ProsperWorks was founded by Jon Lee, Kelly Cheng and Andrew Hu with the commitment to empower small business sales and marketing. Jon was Founder/CEO of three big data companies that solved optimization problems in advertising, gaming and photo sharing. Each company realized successful exits. The team also includes the leaders in engineering and product from Facebook Mobile, BaseCRM and Salesforce. ProsperWorks has raised $10 million in funding from True Ventures, Bloomberg Beta, Crunchfund and other high-profile angel investors. ProsperWorks is based in San Francisco, CA. Approx. Number of Employees: 30 Founded: 2011 Keywords: Automotive, CRM, Finance, Google, Google Apps, Leadership, Management, Podcasting, SAAS, Sales, Small Business email_domain: copper.com id: 9607579 interaction_count: 0 name: Copper phone_numbers: - category: work number: '4153554776' socials: - category: linkedin url: https://www.linkedin.com/company/copper-inc- - category: twitter url: https://twitter.com/Copper - category: facebook url: https://www.facebook.com/Copper - category: klout url: http://klout.com/Copper - category: other url: https://angel.co/copper - category: other url: https://plus.google.com/u/0/103594665195397142807 - category: other url: http://www.crunchbase.com/organization/copper websites: - category: work url: www.copper.com - category: work url: https://www.copper.com - tags: [] address: city: Philadelphia country: '' postal_code: '19135' state: PA street: 543 Washington Ave assignee_id: null contact_type_id: null custom_fields: - custom_field_definition_id: 100764 value: null - custom_field_definition_id: 103481 value: null date_created: 1483988828 date_modified: 1489018922 details: null email_domain: null id: 9607581 interaction_count: 0 name: Sabre Inc (sample) phone_numbers: [] socials: [] websites: [] 7TasksGetTaskByIdResponse: type: object properties: tags: type: array items: {} example: [] assignee_id: type: number example: 137658 completed_date: nullable: true example: null custom_fields: type: array items: {} example: [] date_created: type: number example: 1496712856 date_modified: type: number example: 1496712857 details: nullable: true example: null due_date: type: number example: 1496799000 id: type: number example: 3716920 name: type: string example: My First Task priority: type: string example: None related_resource: type: object properties: id: type: number example: 144296 type: type: string example: project reminder_date: nullable: true example: null status: type: string example: Open 7TasksUpdateTaskRecordResponse: type: object properties: tags: type: array items: {} example: [] assignee_id: type: number example: 137658 completed_date: nullable: true example: null custom_fields: type: array items: {} example: [] date_created: type: number example: 1496712856 date_modified: type: number example: 1496776369 details: type: string example: This is an update due_date: type: number example: 1496799000 id: type: number example: 3716920 name: type: string example: My First Task priority: type: string example: None related_resource: type: object properties: id: type: number example: 144296 type: type: string example: project reminder_date: nullable: true example: null status: type: string example: Open 7TasksCreateNewTaskResponse: type: object properties: tags: type: array items: {} example: [] assignee_id: type: number example: 137658 completed_date: nullable: true example: null custom_fields: type: array items: {} example: [] date_created: type: number example: 1496771985 date_modified: type: number example: 1496771985 details: nullable: true example: null due_date: nullable: true example: null id: type: number example: 3726701 name: type: string example: Demo Task priority: type: string example: None related_resource: type: object properties: id: nullable: true example: null type: nullable: true example: null reminder_date: nullable: true example: null status: type: string example: Open 7TasksRemoveTaskRecordResponse: type: object properties: id: type: number example: 99999999 is_deleted: type: boolean example: true 7TasksListTasksSearchResponse: type: array items: type: object properties: tags: type: array items: {} example: [] assignee_id: nullable: true example: null completed_date: type: number example: 1516822940 custom_activity_type_id: type: number example: 6 custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 8 value: nullable: true example: null anyOf: - type: boolean nullable: true example: true - type: array items: {} example: [] - nullable: true example: null - nullable: true example: null - nullable: true example: null example: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: type: number example: 1515434871 date_modified: type: number example: 1516822940 details: nullable: true example: null due_date: type: number example: 1515517200 id: type: number example: 2 name: type: string example: Follow up on Price Quote (sample) priority: type: string example: None related_resource: type: object properties: id: type: number example: 4 type: type: string example: opportunity reminder_date: nullable: true example: null status: type: string example: Completed example: - tags: [] assignee_id: null completed_date: 1516822940 custom_activity_type_id: 6 custom_fields: - custom_field_definition_id: 8 value: null - custom_field_definition_id: 11 value: null - custom_field_definition_id: 9 value: null - custom_field_definition_id: 7 value: false - custom_field_definition_id: 3 value: null - custom_field_definition_id: 4 value: null - custom_field_definition_id: 12 value: [] - custom_field_definition_id: 10 value: null - custom_field_definition_id: 6 value: null - custom_field_definition_id: 5 value: null date_created: 1515434871 date_modified: 1516822940 details: null due_date: 1515517200 id: 2 name: Follow up on Price Quote (sample) priority: None related_resource: id: 4 type: opportunity reminder_date: null status: Completed 8ActivitiesGetActivityByIdResponse: type: object properties: activity_date: type: number example: 1496710783 date_created: type: number example: 1496710787 date_modified: type: number example: 1496710783 details: type: string example: Demo phone call id: type: number example: 3061844454 new_value: nullable: true example: null old_value: nullable: true example: null parent: type: object properties: id: type: number example: 9607580 type: type: string example: company type: type: object properties: category: type: string example: user id: type: number example: 190711 user_id: type: number example: 137658 8ActivitiesCreateNewActivityResponse: type: object properties: activity_date: type: number example: 1496772355 date_created: type: number example: 1496772355 date_modified: type: number example: 1496772355 details: type: string example: This is the description of this note id: type: number example: 3064242278 new_value: nullable: true example: null old_value: nullable: true example: null parent: type: object properties: id: type: number example: 27140359 type: type: string example: person type: type: object properties: category: type: string example: user id: type: number example: 0 user_id: type: number example: 137658 8ActivitiesRemoveActivityRecordResponse: type: object properties: id: type: number example: 99999999 is_deleted: type: boolean example: true 8ActivitiesListSearchResponse: type: array items: type: object properties: activity_date: type: number example: 1516302332 date_created: type: number example: 1516302332 date_modified: type: number example: 1516302332 details: nullable: true example: null id: type: number example: 203 new_value: nullable: true example: null old_value: nullable: true example: null parent: type: object properties: id: type: number example: 4 type: type: string example: person type: type: object properties: category: type: string example: system id: type: number example: 1 user_id: type: number example: 2 example: - activity_date: 1516302332 date_created: 1516302332 date_modified: 1516302332 details: null id: 203 new_value: null old_value: null parent: id: 4 type: person type: category: system id: 1 user_id: 2 8ActivitiesListActivityTypesResponse: type: object properties: system: type: array items: type: object properties: category: type: string example: system count_as_interaction: type: boolean example: false id: type: number example: 1 is_disabled: type: boolean example: false name: type: string example: Property Changed example: - category: system count_as_interaction: false id: 1 is_disabled: false name: Property Changed - category: system count_as_interaction: false id: 3 is_disabled: false name: Pipeline Stage Changed user: type: array items: type: object properties: category: type: string example: user count_as_interaction: type: boolean example: false id: type: number example: 0 is_disabled: type: boolean example: false name: type: string example: Note example: - category: user count_as_interaction: false id: 0 is_disabled: false name: Note - category: user count_as_interaction: true id: 190711 is_disabled: false name: Phone Call - category: user count_as_interaction: true id: 190712 is_disabled: false name: Meeting - category: user count_as_interaction: true id: 191400 is_disabled: false name: Demo call - category: user count_as_interaction: true id: 194674 is_disabled: false name: Call - no connect CustomFieldsListDefinitionsResponse: type: array items: type: object properties: available_on: type: array items: type: string example: company example: - company - opportunity - lead - person data_type: type: string example: String id: type: number example: 100764 name: type: string example: A Text Field options: type: array items: type: object properties: id: type: number example: 167776 name: type: string example: Yellow rank: type: number example: 4 example: - id: 167776 name: Yellow rank: 4 - id: 167775 name: Orange rank: 3 - id: 167774 name: Blue rank: 2 - id: 167773 name: Green rank: 1 - id: 167772 name: Red rank: 0 example: - available_on: - company - opportunity - lead - person data_type: String id: 100764 name: A Text Field - available_on: - lead - company - opportunity - person data_type: Text id: 103481 name: A Text Area Field - available_on: - opportunity - project data_type: Dropdown id: 126240 name: Color option options: - id: 167776 name: Yellow rank: 4 - id: 167775 name: Orange rank: 3 - id: 167774 name: Blue rank: 2 - id: 167773 name: Green rank: 1 - id: 167772 name: Red rank: 0 CustomFieldsCreateFieldDefinitionResponse: type: object properties: available_on: type: array items: type: string example: lead example: - lead - person - company - project - task canonical_name: nullable: true example: null currency: type: string example: CAD data_type: type: string example: Dropdown id: type: number example: 5 name: type: string example: A Dropdown options: type: array items: type: object properties: id: type: number example: 5 name: type: string example: Option1 rank: type: number example: 0 example: - id: 5 name: Option1 rank: 0 - id: 6 name: Option2 rank: 1 CustomFieldsDeleteCustomFieldDefinitionResponse: type: object properties: id: type: number example: 6 is_deleted: type: boolean example: true CustomFieldsGetDefinitionResponse: type: object properties: available_on: type: array items: type: string example: opportunity example: - opportunity - project data_type: type: string example: Dropdown id: type: number example: 126240 name: type: string example: Color option options: type: array items: type: object properties: id: type: number example: 167776 name: type: string example: Yellow rank: type: number example: 4 example: - id: 167776 name: Yellow rank: 4 - id: 167775 name: Orange rank: 3 - id: 167774 name: Blue rank: 2 - id: 167773 name: Green rank: 1 - id: 167772 name: Red rank: 0 CustomFieldsUpdateExistingDefinitionResponse: type: object properties: available_on: type: array items: type: string example: lead example: - lead - person - opportunity canonical_name: nullable: true example: null data_type: type: string example: Dropdown id: type: number example: 3 name: type: string example: A Dropdown options: type: array items: type: object properties: id: type: number example: 7 name: type: string example: Option 1 rank: type: number example: 0 example: - id: 7 name: Option 1 rank: 0 - id: 8 name: Option 2 rank: 1 - id: 9 name: Option 3 rank: 2 CustomFieldsSearchEntityByCustomFieldResponse: type: array items: type: object properties: tags: type: array items: type: string example: sample example: - sample title: type: string example: Manager address: type: object properties: city: type: string example: Scranton country: nullable: true example: null postal_code: type: string example: '18503' state: type: string example: PA street: type: string example: 213 West Main St assignee_id: nullable: true example: null company_name: type: string example: Dunder Mifflin, Inc. custom_fields: type: array items: type: object properties: custom_field_definition_id: type: number example: 1 value: example: Blah anyOf: - type: string example: Blah - type: number example: 1 - type: number example: 1518595200 - type: boolean example: true - type: number example: 42 - type: string example: http://blah.com - type: number example: 50 - type: number example: 1000 - type: array items: type: number example: 3 example: - 3 example: - custom_field_definition_id: 1 value: Blah - custom_field_definition_id: 2 value: blah blah blah - custom_field_definition_id: 3 value: 1 - custom_field_definition_id: 4 value: 1518595200 - custom_field_definition_id: 5 value: true - custom_field_definition_id: 6 value: 42 - custom_field_definition_id: 7 value: http://blah.com - custom_field_definition_id: 8 value: 50 - custom_field_definition_id: 9 value: 1000 - custom_field_definition_id: 10 value: - 3 customer_source_id: type: number example: 1 date_created: type: number example: 1518656437 date_last_contacted: nullable: true example: null date_modified: type: number example: 1518657195 details: type: string example: >- A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity. Once your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works! email: type: object properties: category: type: string example: work email: type: string example: jim@dundermifflin.com first_name: type: string example: Jim Halpert (sample) id: type: number example: 2 interaction_count: type: number example: 0 last_name: nullable: true example: null middle_name: nullable: true example: null monetary_unit: nullable: true example: null monetary_value: type: number example: 2500 name: type: string example: Jim Halpert (sample) phone_numbers: type: array items: type: object properties: category: type: string example: work number: type: string example: '5104447778' example: - category: work number: '5104447778' prefix: nullable: true example: null socials: type: array items: {} example: [] status: type: string example: New status_id: type: number example: 1 suffix: nullable: true example: null websites: type: array items: type: object properties: category: type: string example: work url: type: string example: http://www.dundermifflin.com example: - category: work url: http://www.dundermifflin.com example: - tags: - sample title: Manager address: city: Scranton country: null postal_code: '18503' state: PA street: 213 West Main St assignee_id: null company_name: Dunder Mifflin, Inc. custom_fields: - custom_field_definition_id: 1 value: Blah - custom_field_definition_id: 2 value: blah blah blah - custom_field_definition_id: 3 value: 1 - custom_field_definition_id: 4 value: 1518595200 - custom_field_definition_id: 5 value: true - custom_field_definition_id: 6 value: 42 - custom_field_definition_id: 7 value: http://blah.com - custom_field_definition_id: 8 value: 50 - custom_field_definition_id: 9 value: 1000 - custom_field_definition_id: 10 value: - 3 customer_source_id: 1 date_created: 1518656437 date_last_contacted: null date_modified: 1518657195 details: >- A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity. Once your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works! email: category: work email: jim@dundermifflin.com first_name: Jim Halpert (sample) id: 2 interaction_count: 0 last_name: null middle_name: null monetary_unit: null monetary_value: 2500 name: Jim Halpert (sample) phone_numbers: - category: work number: '5104447778' prefix: null socials: [] status: New status_id: 1 suffix: null websites: - category: work url: http://www.dundermifflin.com CustomFieldsListAllActivityTypesResponse: type: array items: type: object properties: company_id: type: number example: 1 icon_type: type: string example: Phone id: type: number example: 1 is_default_task_type: type: boolean nullable: true example: true is_disabled: type: boolean example: false is_interaction: type: boolean example: true name: type: string example: Phone Call example: - company_id: 1 icon_type: Phone id: 1 is_default_task_type: null is_disabled: false is_interaction: true name: Phone Call - company_id: 1 icon_type: Event id: 2 is_default_task_type: null is_disabled: false is_interaction: true name: Meeting - company_id: 1 icon_type: Todo id: 3 is_default_task_type: true is_disabled: false is_interaction: false name: To Do - company_id: 1 icon_type: Event id: 4 is_default_task_type: null is_disabled: false is_interaction: true name: Custom Meeting CustomFieldsCreateCustomActivityTypeResponse: type: object properties: company_id: type: number example: 1 icon_type: type: string example: Phone id: type: number example: 5 is_default_task_type: nullable: true example: null is_disabled: type: boolean example: false is_interaction: type: boolean example: false name: type: string example: New Activity CustomFieldsGetActivityTypeResponse: type: object properties: company_id: type: number example: 1 icon_type: type: string example: Event id: type: number example: 4 is_default_task_type: nullable: true example: null is_disabled: type: boolean example: false is_interaction: type: boolean example: true name: type: string example: Custom Meeting CustomFieldsUpdateExistingActivityTypeResponse: type: object properties: company_id: type: number example: 1 icon_type: type: string example: Todo id: type: number example: 5 is_default_task_type: nullable: true example: null is_disabled: type: boolean example: false is_interaction: type: boolean example: false name: type: string example: New Activity CustomFieldsGetConnectionsResponse: type: array items: type: object properties: custom_field_definition_id: type: number example: 172 id: type: number example: 375 source: type: object properties: entity_type: type: string example: people id: type: number example: 1021 name: type: string example: '1021' target: type: object properties: entity_type: type: string example: user id: type: number example: 155 name: type: string example: deque deque example: - custom_field_definition_id: 172 id: 375 source: entity_type: people id: 1021 name: '1021' target: entity_type: user id: 155 name: deque deque CustomFieldsCreateConnectionResponse: type: object properties: custom_field_definition_id: type: number example: 169 id: type: number example: 2103 source: type: object properties: entity_type: type: string example: lead id: type: number example: 1001 name: type: string example: '1001' target: type: object properties: entity_type: type: string example: lead id: type: number example: 1002 name: type: string example: '1002' CustomFieldsDeleteConnectionResponse: type: object properties: ids: type: array items: type: number example: 40085 example: - 40085 - 40086 is_deleted: type: boolean example: true RelatedItemsViewAllRelatedResponse: type: array items: type: object properties: id: type: number example: 4417020 type: type: string example: opportunity example: - id: 4417020 type: opportunity - id: 4418567 type: opportunity RelatedItemsGetAllRelatedResponse: type: array items: type: object properties: id: type: number example: 208105 type: type: string example: project example: - id: 208105 type: project - id: 4417020 type: opportunity - id: 4418567 type: opportunity - id: 13358412 type: company FileUploadListAttachedFilesResponse: type: array items: type: object properties: content_type: type: string example: binary/octet-stream creator_id: type: number example: 46748 date_created: type: number example: 1558049825 date_modified: nullable: true example: null file_name: type: string example: picture.png file_size: type: number example: 3113 id: type: number example: 2556402 is_deleted: type: boolean example: false example: - content_type: binary/octet-stream creator_id: 46748 date_created: 1558049825 date_modified: null file_name: picture.png file_size: 3113 id: 2556402 is_deleted: false FileUploadRelateToEntityResponse: type: object properties: content_type: type: string example: binary/octet-stream creator_id: type: number example: 342164 date_created: type: number example: 1560203853 date_modified: type: number example: 1560203854 file_name: type: string example: cat.jpeg file_size: type: number example: 38 id: type: number example: 469753997 is_deleted: type: boolean example: false FileUploadGetFileMetadataResponse: type: object properties: content_type: type: string example: binary/octet-stream creator_id: type: number example: 46748 date_created: type: number example: 1558049825 date_modified: type: number example: 1558049826 file_name: type: string example: picture.png file_size: type: number example: 3113 id: type: number example: 2556402 is_deleted: type: boolean example: false FileUploadGetSignedS3UrlResponse: type: object properties: body: type: object properties: acl: type: string example: private aws_access_key_id: type: string example: AKIAJ2SYRNMGJJWLRENA key: type: string example: >- temp_uploads/c3d7ff51-141f-420e-9b89-2946c98f38b6/8583d027-e1d3-4c9d-b184-8b0d6b100ec6 policy: type: string example: >- eyJleHBpcmF0aW9uIjoiMjAxOS0wNS0xN1QxODoyNzozOC4wMDBaIiwiY29uZGl0aW9ucyI6W3siYnVja2V0IjoiYWxpLXVzZXJhc3NldHMtc3RhZ2luZyJ9LHsiYWNsIjoicHJpdmF0ZSJ9LHsia2V5IjoidGVtcF91cGxvYWRzL2MzZDdmZjUxLTE0MWYtNDIwZS05Yjg5LTI5NDZjOThmMzhiNi84NTgzZDAyNy1lMWQzLTRjOWQtYjE4NC04YjBkNmIxMDBlYzYifSxbImNvbnRlbnQtbGVuZ3RoLXJhbmdlIiwwLDEwNzM3NDE4MjRdLHsic3VjY2Vzc19hY3Rpb25fc3RhdHVzIjoiMjAxIn1dfQ== signature: type: string example: nUUFLO43nlg/VzjaqeA+qFGg5+I= success_action_status: type: string example: '201' method: type: string example: POST removed: type: boolean example: true resource: type: object properties: id: type: number example: 473015532 type: type: string example: filedocument sample_curl: type: string example: > curl -X POST -v -F "key=temp_uploads/c3d7ff51-141f-420e-9b89-2946c98f38b6/8583d027-e1d3-4c9d-b184-8b0d6b100ec6" -F "signature=nUUFLO43nlg/VzjaqeA+qFGg5+I=" -F "success_action_status=201" -F "acl=private" -F "policy=eyJleHBpcmF0aW9uIjoiMjAxOS0wNS0xN1QxODoyNzozOC4wMDBaIiwiY29uZGl0aW9ucyI6W3siYnVja2V0IjoiYWxpLXVzZXJhc3NldHMtc3RhZ2luZyJ9LHsiYWNsIjoicHJpdmF0ZSJ9LHsia2V5IjoidGVtcF91cGxvYWRzL2MzZDdmZjUxLTE0MWYtNDIwZS05Yjg5LTI5NDZjOThmMzhiNi84NTgzZDAyNy1lMWQzLTRjOWQtYjE4NC04YjBkNmIxMDBlYzYifSxbImNvbnRlbnQtbGVuZ3RoLXJhbmdlIiwwLDEwNzM3NDE4MjRdLHsic3VjY2Vzc19hY3Rpb25fc3RhdHVzIjoiMjAxIn1dfQ==" -F "aws_access_key_id=AKIAJ2SYRNMGJJWLRENA" -F file=@your-file.txt "https://ali-userassets-staging.s3.amazonaws.com/" url: type: string example: https://ali-userassets-staging.s3.amazonaws.com/ WebhooksListSubscriptionsResponse: type: array items: type: object properties: created_at: type: number example: 1489173015 event: type: string example: update id: type: number example: 17065 secret: type: object properties: key: type: string example: copper_notifications secret: type: string example: hook_source target: type: string example: https://your.endpoint.here type: type: string example: lead example: - created_at: 1489173015 event: update id: 17065 secret: key: copper_notifications secret: hook_source target: https://your.endpoint.here type: lead - created_at: 1496787761 event: update id: 25347 secret: key: copper_notifications secret: hook_source target: https://your.endpoint.here type: person - created_at: 1510271719 event: update id: 39285 secret: key: copper_notifications secret: hook_source target: https://hookb.in/KAnAXW5q type: activity_log - created_at: 1510271965 event: delete id: 39286 secret: key: copper_notifications secret: hook_source target: https://hookb.in/KAnAXW5q type: activity_log - created_at: 1510272356 event: new id: 39287 secret: key: copper_notifications secret: hook_source target: https://hookbin.com/bin/KAnAXW5q type: lead - created_at: 1510272369 event: new id: 39288 secret: key: copper_notifications secret: hook_source target: https://hookbin.com/bin/KAnAXW5q type: activity_log WebhooksCreateSubscriptionEventResponse: type: object properties: created_at: type: number example: 1489173015 event: type: string example: update id: type: number example: 17065 secret: type: object properties: key: type: string example: copper_notifications secret: type: string example: hook_source target: type: string example: https://your.endpoint.here type: type: string example: lead WebhooksUnsubscribeResponse: type: object properties: id: type: number example: 17065 WebhooksViewSubscriptionByIdResponse: type: object properties: created_at: type: number example: 1496787761 event: type: string example: update id: type: number example: 25347 secret: type: object properties: key: type: string example: copper_notifications secret: type: string example: hook_source target: type: string example: https://your.endpoint.here type: type: string example: person