### Get All Lead Sources Source: https://context7.com/onepagecrm/swagger/llms.txt Fetch a list of all predefined lead sources. Requires authentication. ```bash # Get all lead sources curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/lead_sources" ``` -------------------------------- ### Get Account Configuration (Bootstrap) Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieve all global and user-specific configuration settings for the authenticated user. This includes user details, team members, account type, and various customizable fields. ```bash # Get bootstrap data for the authenticated user curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/bootstrap" ``` -------------------------------- ### Get All Tags Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieve a list of all tags used within the CRM. Requires authentication. ```bash # Get all tags curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/tags" ``` -------------------------------- ### Get Countries List Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieves a comprehensive list of supported countries and their ISO-3166 two-letter codes. Authentication is required. ```bash curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/countries" ``` -------------------------------- ### Get All Statuses Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieve a list of all predefined contact statuses. Requires authentication. ```bash # Get all statuses curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/statuses" ``` -------------------------------- ### Bootstrap - Get Account Configuration Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieves all global and user-specific configuration settings for the authenticated user, including user details, team members, account type, and custom fields. ```APIDOC ## Bootstrap — Get Account Configuration Returns all global and user-specific configuration in a single call: `user_id`, `auth_key`, team members, account type, settings, custom/deal/company fields, call results, lead sources, statuses, tags, predefined actions, and quick-date options. ### Method GET ### Endpoint https://app.onepagecrm.com/api/v3/bootstrap ### Request Example ```bash # Get bootstrap data for the authenticated user curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/bootstrap" ``` ### Response Example (abridged) ```json { "status": 0, "message": "OK", "timestamp": 1700000000, "data": { "user_id": "5aba31e99007ba0f570c12f7", "auth_key": "c+g0Y3VGHdIztKbHcjVcOuwf34EmFlXI9Qot5hTvb2F=", "user": { "id": "5aba31e99007ba0f570c12f7", "first_name": "Jane", "last_name": "Doe", ... }, "team": [...], "account_type": "pro", "settings": { "currency": "USD", "date_format": "MM/DD/YYYY", ... }, "custom_fields": [...], "deal_fields": [...], "lead_sources": [...], "predefined_actions": [] } } ``` ``` -------------------------------- ### Get a Specific Pipeline Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieve details for a single sales pipeline by its ID. Requires authentication. ```bash # Get a specific pipeline curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/pipelines/5aba31e99007ba0f570cee01" ``` -------------------------------- ### Get Standalone Action List Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieves a list of actions across all contacts, filterable by date range. ```bash curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/actions?date_filter=date&since=1700000000&until=1702678400" ``` -------------------------------- ### Get Specific Company Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieves details for a single company using its unique ID. ```bash curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/companies/5aba31e99007ba0f570c92ab" ``` -------------------------------- ### Get Pinned Attachments for a Company Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieve all attachments pinned to a specific company. Requires authentication. ```bash # Get pinned attachments for a company curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/companies/5aba31e99007ba0f570c92ab/pinned_attachments" ``` -------------------------------- ### Get Specific Company Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieves details for a specific company by its ID. ```APIDOC ## GET /companies/{id} ### Description Retrieves a specific company by its ID. ### Method GET ### Endpoint `/companies/{id}` ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the company. ``` -------------------------------- ### Get a Specific Webhook Source: https://context7.com/onepagecrm/swagger/llms.txt Fetches details of a single webhook identified by its ID. Ensure you have the correct webhook ID and credentials. ```bash curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/webhooks/5aba31ea9007ba0f570caa01" ``` -------------------------------- ### Get a specific webhook Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieves the details of a specific webhook using its ID. ```APIDOC ## GET /webhooks/{id} ### Description Retrieves the details of a specific webhook. ### Method GET ### Endpoint /api/v3/webhooks/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the webhook. ``` -------------------------------- ### Get Action Stream Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieves contacts sorted by their next action due date, similar to the web app view. ```APIDOC ## GET /action_stream ### Description Retrieves contacts sorted by their next action due date. ### Method GET ### Endpoint `/action_stream` ### Parameters #### Query Parameters - **has_actions_today** (boolean) - Optional - If true, only contacts with actions due today are returned. - **per_page** (integer) - Optional - The number of results per page. ``` -------------------------------- ### Get a Specific Notification Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieves a single notification by its ID. Ensure your USER_ID and API_KEY are correctly set. ```bash curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/notifications/5aba31ea9007ba0f570cff10" ``` -------------------------------- ### Get Pinned Attachments for a Contact Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieve all attachments pinned to a specific contact, sorted by the most recent pinning date. Requires authentication. ```bash # Get pinned attachments for a contact (sorted by pinned_at, most recent first) curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/contacts/5aba31ea9007ba0f570c92d4/pinned_attachments" ``` -------------------------------- ### Create a Predefined Action Source: https://context7.com/onepagecrm/swagger/llms.txt Add a new predefined action template. Requires authentication. ```bash # Create a predefined action curl -u "$USER_ID:$API_KEY" \ -X POST \ -H "Content-Type: application/json" \ -d '{"text": "Send follow-up email", "period": "days", "number": 3}' \ "https://app.onepagecrm.com/api/v3/predefined_actions" ``` -------------------------------- ### Create a Predefined Item Source: https://context7.com/onepagecrm/swagger/llms.txt Add a new predefined item template for products or services. Requires authentication. ```bash # Create a predefined item curl -u "$USER_ID:$API_KEY" \ -X POST \ -H "Content-Type: application/json" \ -d '{"name": "Annual SaaS License", "unit_price": 1200.00, "currency": "USD"}' \ "https://app.onepagecrm.com/api/v3/predefined_items" ``` -------------------------------- ### List Predefined Items Source: https://context7.com/onepagecrm/swagger/llms.txt Fetch a list of all predefined items, which are templates for products or services. Requires authentication. ```bash # List predefined items curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/predefined_items" ``` -------------------------------- ### Get a specific notification Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieves the details of a specific notification using its ID. ```APIDOC ## GET /notifications/{id} ### Description Retrieves the details of a specific notification. ### Method GET ### Endpoint /api/v3/notifications/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the notification. ``` -------------------------------- ### List Predefined Actions Source: https://context7.com/onepagecrm/swagger/llms.txt Fetch a list of all predefined actions, which are templates for common sales tasks. Requires authentication. ```bash # List predefined actions curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/predefined_actions" ``` -------------------------------- ### List All Pipelines Source: https://context7.com/onepagecrm/swagger/llms.txt Fetch a list of all available sales pipelines. Requires authentication. ```bash # List all pipelines curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/pipelines" ``` -------------------------------- ### Create a Deal Source: https://context7.com/onepagecrm/swagger/llms.txt Use POST to create a new deal for a contact, specifying details like name, amount, stage, and expected close date. Requires contact ID. ```bash curl -u "$USER_ID:$API_KEY" \ -X POST \ -H "Content-Type: application/json" \ -d '{ "name": "Enterprise License Q3", "amount": 15000, "stage": 3, "status": "pending", "expected_close_date": "2024-09-30", "months": 12, "commission_type": "percentage", "commission_percentage": 10.0, "deal_fields": [{ "deal_field": { "id": "5aad9b039007ba28c9ebad56" }, "value": "Annual" }] }' \ "https://app.onepagecrm.com/api/v3/contacts/5aba31ea9007ba0f570c92d4/deals" ``` -------------------------------- ### List All Webhooks Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieves a list of all configured webhooks for the account. Authentication is required. ```bash curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/webhooks" ``` -------------------------------- ### List Deal Fields Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieve a list of all predefined fields for deals. Requires authentication. ```bash # List deal fields curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/deal_fields" ``` -------------------------------- ### Create a Note Linked to a Deal Source: https://context7.com/onepagecrm/swagger/llms.txt Use POST to create a new note for a contact, optionally linking it to a deal and notifying specific users. Requires contact ID. ```bash curl -u "$USER_ID:$API_KEY" \ -X POST \ -H "Content-Type: application/json" \ -d '{ "text": "Discussed pricing; decision expected by end of quarter.", "date": "2024-06-10", "linked_deal_id": "5aba31ea9007ba0f570cbb01", "user_ids_to_notify": ["5aba31e99007ba0f570c12f8"] }' \ "https://app.onepagecrm.com/api/v3/contacts/5aba31ea9007ba0f570c92d4/notes" ``` -------------------------------- ### List Predefined Action Groups Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieve a list of all predefined action groups, used for organizing action templates. Requires authentication. ```bash # List predefined action groups curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/predefined_action_groups" ``` -------------------------------- ### Create a New Contact Source: https://context7.com/onepagecrm/swagger/llms.txt Create a new contact by sending a POST request with contact details in JSON format. Includes fields for names, job title, company, emails, phones, status, tags, and custom fields. ```bash # Create a new contact curl -u "$USER_ID:$API_KEY" \ -X POST \ -H "Content-Type: application/json" \ -d '{ "first_name": "John", "last_name": "Smith", "job_title": "CTO", "company_name": "TechCorp", "emails": [{ "type": "work", "value": "john.smith@techcorp.com" }], "phones": [{ "type": "work", "value": "+1-555-0100" }], "status_id": "5aba31e99007ba0f570c1234", "tags": ["prospect", "enterprise"], "custom_fields": [{ "custom_field": { "id": "5aad9b039007ba28c9ebad56" }, "value": "Large" }] }' \ "https://app.onepagecrm.com/api/v3/contacts" ``` -------------------------------- ### List Predefined Item Groups Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieve a list of all predefined item groups, used for organizing product/service templates. Requires authentication. ```bash # List predefined item groups curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/predefined_item_groups" ``` -------------------------------- ### Attach a File to a Note Source: https://context7.com/onepagecrm/swagger/llms.txt Upload a file and attach it to a specific note using multipart upload. Ensure the file path is correct. ```bash # Attach a file to a note (multipart upload) curl -u "$USER_ID:$API_KEY" \ -X POST \ -F "file=@/path/to/contract.pdf" \ "https://app.onepagecrm.com/api/v3/notes/5aba31ea9007ba0f570ccc01/attachments" ``` -------------------------------- ### Log a Meeting with a Contact Source: https://context7.com/onepagecrm/swagger/llms.txt Use this endpoint to log a meeting with a specific contact, including details like text, date, and meeting result. Requires authentication. ```bash # Create a meeting log curl -u "$USER_ID:$API_KEY" \ -X POST \ -H "Content-Type: application/json" \ -d '{ "text": "Product demo at client office.", "date": "2024-06-15", "meeting_result": "interested" }' \ "https://app.onepagecrm.com/api/v3/contacts/5aba31ea9007ba0f570c92d4/meetings" ``` -------------------------------- ### List all webhooks Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieves a list of all webhooks configured for the account. ```APIDOC ## GET /webhooks ### Description Lists all webhooks registered for the account. ### Method GET ### Endpoint /api/v3/webhooks ``` -------------------------------- ### Enable Status Sync for Company Contacts Source: https://context7.com/onepagecrm/swagger/llms.txt Use POST to enable status synchronization for contacts within a company, specifying the status ID. Requires company ID. ```bash curl -u "$USER_ID:$API_KEY" \ -X POST \ -H "Content-Type: application/json" \ -d '{"status_id": "5aba31e99007ba0f570c1234"}' \ "https://app.onepagecrm.com/api/v3/companies/5aba31e99007ba0f570c92ab/synced_status" ``` -------------------------------- ### List Company Fields Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieve a list of all predefined fields for companies. Requires authentication. ```bash # List company fields curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/company_fields" ``` -------------------------------- ### Log a New Call Source: https://context7.com/onepagecrm/swagger/llms.txt Use POST to log a phone call for a contact, including details like text, call result, date, and via number. Requires contact ID. ```bash curl -u "$USER_ID:$API_KEY" \ -X POST \ -H "Content-Type: application/json" \ -d '{ "text": "Discussed renewal options.", "call_result": "interested", "date": "2024-06-11", "via": "+1-555-0100" }' \ "https://app.onepagecrm.com/api/v3/contacts/5aba31ea9007ba0f570c92d4/calls" ``` -------------------------------- ### Create Contact Relationship Source: https://context7.com/onepagecrm/swagger/llms.txt Establishes a typed relationship between two contacts, specifying the relationship type and the related contacts. ```bash curl -u "$USER_ID:$API_KEY" \ -X POST \ -H "Content-Type: application/json" \ -d '{ "relationship_type_id": "5aaa9b059007ba08c9ebaf57", "related_contacts": [ { "contact_id": "5aba31ea9007ba0f570c92d4", "variant_id": "5aaa9b059007ba08c9ebaf59" }, { "contact_id": "5aba31ea9007ba0f570c92d5", "variant_id": "5aaa9b059007ba08c9ebaf59" } ] }' \ "https://app.onepagecrm.com/api/v3/contacts/5aba31ea9007ba0f570c92d4/relationships" ``` -------------------------------- ### Link Contact to Company Source: https://context7.com/onepagecrm/swagger/llms.txt Use POST to associate a contact with a company. Requires company ID and contact ID. ```bash curl -u "$USER_ID:$API_KEY" \ -X POST \ -H "Content-Type: application/json" \ -d '{"contact_id": "5aba31ea9007ba0f570c92d4"}' \ "https://app.onepagecrm.com/api/v3/companies/5aba31e99007ba0f570c92ab/linked_contacts" ``` -------------------------------- ### List Custom Fields for Contacts Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieve a list of all custom fields configured for contacts. Requires authentication and administrator privileges. ```bash # List custom fields for contacts curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/custom_fields" ``` -------------------------------- ### Create Action for a Contact Source: https://context7.com/onepagecrm/swagger/llms.txt Creates a new action (completable task) for a specific contact, including details like text, date, time, status, and assignee. ```bash curl -u "$USER_ID:$API_KEY" \ -X POST \ -H "Content-Type: application/json" \ -d '{ "text": "Send proposal", "date": "2024-06-20", "exact_time": "09:00", "status": "asap", "assignee_id": "5aba31e99007ba0f570c12f7" }' \ "https://app.onepagecrm.com/api/v3/contacts/5aba31ea9007ba0f570c92d4/actions" ``` -------------------------------- ### Update Company Details Source: https://context7.com/onepagecrm/swagger/llms.txt Use PUT to update company information like name, website, and phone number. Requires company ID. ```bash curl -u "$USER_ID:$API_KEY" \ -X PUT \ -H "Content-Type: application/json" \ -d '{ "name": "ACME Corp Ltd.", "website": "https://acme.example.com", "phone": "+1-555-0200" }' \ "https://app.onepagecrm.com/api/v3/companies/5aba31e99007ba0f570c92ab" ``` -------------------------------- ### Create Note Source: https://context7.com/onepagecrm/swagger/llms.txt Creates a new note for a contact, optionally linking it to a deal and notifying specific users. ```APIDOC ## POST /api/v3/contacts/{id}/notes ### Description Creates a new note for a contact. ### Method POST ### Endpoint /api/v3/contacts/{id}/notes ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the contact to associate the note with. #### Request Body - **text** (string) - Required - The content of the note. - **date** (string) - Optional - The date the note was created (YYYY-MM-DD). - **linked_deal_id** (string) - Optional - The ID of a deal to link this note to. - **user_ids_to_notify** (array) - Optional - A list of user IDs to notify about this note. - **user_id** (string) - Required - The ID of the user to notify. ### Request Example ```json { "text": "Discussed pricing; decision expected by end of quarter.", "date": "2024-06-10", "linked_deal_id": "5aba31ea9007ba0f570cbb01", "user_ids_to_notify": ["5aba31e99007ba0f570c12f8"] } ``` ### Response #### Success Response (200) (Response details not provided in source) ``` -------------------------------- ### Predefined Actions and Predefined Action Groups — Action Templates Source: https://context7.com/onepagecrm/swagger/llms.txt Manage predefined actions and action groups, which serve as templates for common sales workflows. ```APIDOC ## GET /predefined_actions ### Description Lists all available predefined actions. ### Method GET ### Endpoint /predefined_actions ``` ```APIDOC ## POST /predefined_actions ### Description Creates a new predefined action. ### Method POST ### Endpoint /predefined_actions ### Parameters #### Request Body - **text** (string) - Required - The description of the action. - **period** (string) - Required - The time period for the action (e.g., "days"). - **number** (integer) - Required - The number of periods. ``` ```APIDOC ## GET /predefined_action_groups ### Description Lists all predefined action groups. ### Method GET ### Endpoint /predefined_action_groups ``` -------------------------------- ### Create a Custom Status Source: https://context7.com/onepagecrm/swagger/llms.txt Add a new custom status for contacts. Requires authentication and administrator privileges. ```bash # Create a custom status curl -u "$USER_ID:$API_KEY" \ -X POST \ -H "Content-Type: application/json" \ -d '{"text": "Nurture", "color": "#FF9900"}' \ "https://app.onepagecrm.com/api/v3/statuses" ``` -------------------------------- ### List all countries Source: https://context7.com/onepagecrm/swagger/llms.txt Returns a lookup list of all supported countries and their ISO-3166 two-letter codes. ```APIDOC ## GET /countries ### Description Returns a list of all supported countries and their ISO-3166 two-letter codes. ### Method GET ### Endpoint /api/v3/countries ### Response #### Success Response (200) - **data** (object) - Contains the list of countries. - **countries** (array) - A list of country objects. - **code** (string) - The ISO-3166 two-letter country code. - **name** (string) - The name of the country. ``` -------------------------------- ### List Notes for a Contact Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieve all notes associated with a specific contact. Requires contact ID. ```bash curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/contacts/5aba31ea9007ba0f570c92d4/notes" ``` -------------------------------- ### List Contacts with Filters Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieve a list of contacts with support for pagination, sorting, and filtering by search terms, tags, status, lead source, owner, and date ranges. ```bash # List contacts — page 1, 20 per page, sorted by first name descending curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/contacts?per_page=20&page=1&sort_by=first_name&order=desc" ``` ```bash # Search by text curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/contacts?search=John" ``` -------------------------------- ### Create Deal Source: https://context7.com/onepagecrm/swagger/llms.txt Creates a new deal for a contact, including details like name, amount, stage, and expected close date. ```APIDOC ## POST /api/v3/contacts/{id}/deals ### Description Creates a new deal for a contact. ### Method POST ### Endpoint /api/v3/contacts/{id}/deals ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the contact to associate the deal with. #### Request Body - **name** (string) - Required - The name of the deal. - **amount** (number) - Required - The monetary amount of the deal. - **stage** (integer) - Required - The stage of the deal (numeric identifier). - **status** (string) - Required - The current status of the deal (e.g., 'pending'). - **expected_close_date** (string) - Optional - The expected date the deal will close (YYYY-MM-DD). - **months** (integer) - Optional - Duration in months. - **commission_type** (string) - Optional - Type of commission (e.g., 'percentage'). - **commission_percentage** (number) - Optional - The commission percentage. - **deal_fields** (array) - Optional - Custom fields for the deal. - **deal_field** (object) - Contains id and value for a custom field. - **id** (string) - Required - The ID of the custom deal field. - **value** (string) - Required - The value for the custom deal field. ### Request Example ```json { "name": "Enterprise License Q3", "amount": 15000, "stage": 3, "status": "pending", "expected_close_date": "2024-09-30", "months": 12, "commission_type": "percentage", "commission_percentage": 10.0, "deal_fields": [ { "deal_field": { "id": "5aad9b039007ba28c9ebad56", "value": "Annual" } } ] } ``` ### Response #### Success Response (200) (Response details not provided in source) ``` -------------------------------- ### Create a Custom Field Source: https://context7.com/onepagecrm/swagger/llms.txt Add a new custom field for contacts. Requires authentication and administrator privileges. Specify name, type, and choices if applicable. ```bash # Create a custom field (admin only) curl -u "$USER_ID:$API_KEY" \ -X POST \ -H "Content-Type: application/json" \ -d '{"name": "Company Size", "type": "dropdown", "choices": ["Small", "Medium", "Large"]}' \ "https://app.onepagecrm.com/api/v3/custom_fields" ``` -------------------------------- ### List Deals for a Contact Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieve a list of deals associated with a specific contact. Supports filtering by status. ```bash curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/contacts/5aba31ea9007ba0f570c92d4/deals?status=pending" ``` -------------------------------- ### List All Companies Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieves a list of all companies, with options to control the number of results per page. ```bash curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/companies?per_page=20" ``` -------------------------------- ### List All Notifications Source: https://context7.com/onepagecrm/swagger/llms.txt Fetch a paginated list of in-app notifications for the current user. Excludes email and link notifications. Requires authentication. ```bash # List all notifications (paginated) curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/notifications?per_page=25" ``` -------------------------------- ### Filtered Action Stream Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieves contacts with actions due today, with options to control pagination. ```bash curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/action_stream?has_actions_today=true&per_page=50" ``` -------------------------------- ### Predefined Items and Predefined Item Groups — Deal Product Templates Source: https://context7.com/onepagecrm/swagger/llms.txt Manage predefined items and item groups, used as templates for populating deals with standardized products or services. ```APIDOC ## GET /predefined_items ### Description Lists all available predefined items. ### Method GET ### Endpoint /predefined_items ``` ```APIDOC ## POST /predefined_items ### Description Creates a new predefined item. ### Method POST ### Endpoint /predefined_items ### Parameters #### Request Body - **name** (string) - Required - The name of the item. - **unit_price** (number) - Required - The price per unit. - **currency** (string) - Required - The currency of the price (e.g., "USD"). ``` ```APIDOC ## GET /predefined_item_groups ### Description Lists all predefined item groups. ### Method GET ### Endpoint /predefined_item_groups ``` -------------------------------- ### Create Action for a Contact Source: https://context7.com/onepagecrm/swagger/llms.txt Creates a new action (next step) for a specific contact. ```APIDOC ## POST /contacts/{id}/actions ### Description Creates an action for a contact. ### Method POST ### Endpoint `/contacts/{id}/actions` ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the contact. #### Request Body - **text** (string) - Required - The description of the action. - **date** (string) - Required - The due date for the action (YYYY-MM-DD). - **exact_time** (string) - Optional - The exact time for the action (HH:MM). - **status** (string) - Optional - The status of the action (e.g., 'asap'). - **assignee_id** (string) - Optional - The ID of the user assigned to the action. ``` -------------------------------- ### List Actions for a Contact Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieves a list of actions associated with a specific contact, filterable by status. ```bash curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/contacts/5aba31ea9007ba0f570c92d4/actions?status=active" ``` -------------------------------- ### Manage Sales Cycle Lifecycle Source: https://context7.com/onepagecrm/swagger/llms.txt Close, force-close (deleting active actions), or reopen a contact's sales cycle using PUT requests. Include a comment in the request body for closing actions. ```bash # Close sales cycle (requires no active actions) curl -u "$USER_ID:$API_KEY" \ -X PUT \ -H "Content-Type: application/json" \ -d '{"comment": "Not interested at this time."}' \ "https://app.onepagecrm.com/api/v3/contacts/5aba31e99007ba0f570c92d4/close_sales_cycle" ``` ```bash # Force-close (deletes active actions first) curl -u "$USER_ID:$API_KEY" \ -X PUT \ -H "Content-Type: application/json" \ -d '{"comment": "Closing with outstanding tasks."}' \ "https://app.onepagecrm.com/api/v3/contacts/5aba31e99007ba0f570c92d4/force_close_sales_cycle" ``` ```bash # Reopen the sales cycle curl -u "$USER_ID:$API_KEY" \ -X PUT \ "https://app.onepagecrm.com/api/v3/contacts/5aba31e99007ba0f570c92d4/reopen_sales_cycle" ``` -------------------------------- ### Mark All Notifications as Read Source: https://context7.com/onepagecrm/swagger/llms.txt Marks all notifications for the authenticated user as read. This is a POST request and requires valid credentials. ```bash curl -u "$USER_ID:$API_KEY" \ -X POST \ "https://app.onepagecrm.com/api/v3/notifications/mark_all_as_read" ``` -------------------------------- ### Upload and Remove Contact Photos Source: https://context7.com/onepagecrm/swagger/llms.txt Attach a Base64-encoded image to a contact using POST for creation or PUT for replacement. Use DELETE to remove a photo. ```bash # Encode an image B64=$(base64 -w 0 photo.jpg) # Upload new contact photo (POST creates, PUT replaces) curl -u "$USER_ID:$API_KEY" \ -X POST \ -H "Content-Type: application/json" \ -d "{\"image\": \"$B64\"}" \ "https://app.onepagecrm.com/api/v3/contacts/5aba31e99007ba0f570c92d4/contact_photo" ``` ```bash # Remove a contact's photo curl -u "$USER_ID:$API_KEY" \ -X DELETE \ "https://app.onepagecrm.com/api/v3/contacts/5aba31e99007ba0f570c92d4/contact_photo" ``` -------------------------------- ### Upload Company Logo Source: https://context7.com/onepagecrm/swagger/llms.txt Use POST to upload or replace a company's logo. The image must be base64 encoded. Requires company ID. ```bash B64=$(base64 -w 0 logo.png) # Upload / replace logo (POST or PATCH) curl -u "$USER_ID:$API_KEY" \ -X POST \ -H "Content-Type: application/json" \ -d "{"image": "$B64"}" \ "https://app.onepagecrm.com/api/v3/companies/5aba31e99007ba0f570c92ab/logo" ``` -------------------------------- ### Pipelines — Sales Process Stages Source: https://context7.com/onepagecrm/swagger/llms.txt Manage sales pipelines and their associated stages. Allows listing all pipelines or retrieving a specific pipeline. ```APIDOC ## GET /pipelines ### Description Lists all available sales pipelines. ### Method GET ### Endpoint /pipelines ``` ```APIDOC ## GET /pipelines/{id} ### Description Retrieves details of a specific sales pipeline. ### Method GET ### Endpoint /pipelines/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the pipeline. ``` -------------------------------- ### Sales Cycle - Close, Force-Close, and Reopen Source: https://context7.com/onepagecrm/swagger/llms.txt Manages the sales cycle lifecycle for contacts, including closing, force-closing (which also deletes actions), and reopening. ```APIDOC ## Sales Cycle - Close, Force-Close, and Reopen ### Description Provides endpoints to manage the sales cycle for a contact. This includes closing the cycle, force-closing it (which also removes associated actions), and reopening a closed cycle. ### Method PUT ### Endpoint `/api/v3/contacts/{id}/close_sales_cycle` `/api/v3/contacts/{id}/force_close_sales_cycle` `/api/v3/contacts/{id}/reopen_sales_cycle` ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the contact. #### Request Body (Close/Force-Close) - **comment** (string) - Optional - A comment explaining the reason for closing the sales cycle. ### Request Example (Close Sales Cycle) ```bash curl -u "$USER_ID:$API_KEY" \ -X PUT \ -H "Content-Type: application/json" \ -d '{"comment": "Not interested at this time."}' \ "https://app.onepagecrm.com/api/v3/contacts/5aba31e99007ba0f570c92d4/close_sales_cycle" ``` ### Request Example (Force-Close Sales Cycle) ```bash curl -u "$USER_ID:$API_KEY" \ -X PUT \ -H "Content-Type: application/json" \ -d '{"comment": "Closing with outstanding tasks."}' \ "https://app.onepagecrm.com/api/v3/contacts/5aba31e99007ba0f570c92d4/force_close_sales_cycle" ``` ### Request Example (Reopen Sales Cycle) ```bash curl -u "$USER_ID:$API_KEY" \ -X PUT \ "https://app.onepagecrm.com/api/v3/contacts/5aba31e99007ba0f570c92d4/reopen_sales_cycle" ``` ``` -------------------------------- ### Update a Deal Source: https://context7.com/onepagecrm/swagger/llms.txt Use PUT to modify an existing deal's status, close date, or amount. Requires deal ID. ```bash curl -u "$USER_ID:$API_KEY" \ -X PUT \ -H "Content-Type: application/json" \ -d '{ "status": "won", "close_date": "2024-08-15", "amount": 18000 }' \ "https://app.onepagecrm.com/api/v3/deals/5aba31ea9007ba0f570cbb01" ``` -------------------------------- ### List and Update Team Members Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieve all team members associated with the account or update a specific user's profile information. Use PUT with JSON payload for updates. ```bash # List all users curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/users" ``` ```bash # Get a specific user curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/users/5aba31e99007ba0f570c12f7" ``` ```bash # Update the logged user's own profile (PUT) curl -u "$USER_ID:$API_KEY" \ -X PUT \ -H "Content-Type: application/json" \ -d '{ "first_name": "Jane", "last_name": "Doe", "company_name": "Acme Corp" }' \ "https://app.onepagecrm.com/api/v3/users/5aba31e99007ba0f570c12f7" ``` -------------------------------- ### Update Contact (Partial Update) Source: https://context7.com/onepagecrm/swagger/llms.txt Perform a partial update on an existing contact by sending only the changed fields in the request body. Use the `?partial=true` query parameter. ```bash # Update contact (partial update — only send changed fields) curl -u "$USER_ID:$API_KEY" \ -X PUT \ -H "Content-Type: application/json" \ "https://app.onepagecrm.com/api/v3/contacts/5aba31e99007ba0f570c92d4?partial=true" \ -d '{ "job_title": "VP Engineering" }' ``` -------------------------------- ### Delete a Deal Source: https://context7.com/onepagecrm/swagger/llms.txt Use DELETE to remove a deal. Requires deal ID. ```bash curl -u "$USER_ID:$API_KEY" \ -X DELETE \ "https://app.onepagecrm.com/api/v3/deals/5aba31ea9007ba0f570cbb01" ``` -------------------------------- ### Split a Contact Source: https://context7.com/onepagecrm/swagger/llms.txt Splits a contact, optionally joining another company by providing its name. Leave company_name blank to split without joining another company. ```bash curl -u "$USER_ID:$API_KEY" \ -X PUT \ -H "Content-Type: application/json" \ -d '{"company_name": ""}' \ "https://app.onepagecrm.com/api/v3/contacts/5aba31e99007ba0f570c92d4/split" ``` -------------------------------- ### Custom Fields, Company Fields, and Deal Fields Source: https://context7.com/onepagecrm/swagger/llms.txt Manage custom data fields for contacts, companies, and deals. Includes listing and creating custom fields. ```APIDOC ## GET /custom_fields ### Description Lists all custom fields configured for contacts. ### Method GET ### Endpoint /custom_fields ``` ```APIDOC ## POST /custom_fields ### Description Creates a new custom field for contacts. This operation is admin-only. ### Method POST ### Endpoint /custom_fields ### Parameters #### Request Body - **name** (string) - Required - The name of the custom field. - **type** (string) - Required - The type of the custom field (e.g., "dropdown"). - **choices** (array) - Optional - A list of choices for dropdown or multi-select fields. ``` ```APIDOC ## GET /company_fields ### Description Lists all custom fields configured for companies. ### Method GET ### Endpoint /company_fields ``` ```APIDOC ## GET /deal_fields ### Description Lists all custom fields configured for deals. ### Method GET ### Endpoint /deal_fields ``` -------------------------------- ### Create Contact Relationship Source: https://context7.com/onepagecrm/swagger/llms.txt Creates a typed relationship between two contacts. ```APIDOC ## POST /contacts/{id}/relationships ### Description Creates a relationship between two contacts. ### Method POST ### Endpoint `/contacts/{id}/relationships` ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the primary contact. #### Request Body - **relationship_type_id** (string) - Required - The ID of the relationship type. - **related_contacts** (array) - Required - An array of related contacts. - **contact_id** (string) - Required - The ID of the related contact. - **variant_id** (string) - Required - The variant ID of the relationship. ``` -------------------------------- ### Mark a Single Notification as Read Source: https://context7.com/onepagecrm/swagger/llms.txt Marks a specific notification as read using a POST request. Requires authentication with USER_ID and API_KEY. ```bash curl -u "$USER_ID:$API_KEY" \ -X POST \ "https://app.onepagecrm.com/api/v3/notifications/5aba31ea9007ba0f570cff10/mark_as_read" ``` -------------------------------- ### List Calls for a Contact Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieve a list of logged calls associated with a specific contact. Requires contact ID. ```bash curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/contacts/5aba31ea9007ba0f570c92d4/calls" ``` -------------------------------- ### List Companies Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieves a list of all companies. ```APIDOC ## GET /companies ### Description Lists all companies. ### Method GET ### Endpoint `/companies` ### Parameters #### Query Parameters - **per_page** (integer) - Optional - The number of results per page. ``` -------------------------------- ### Update a Note Source: https://context7.com/onepagecrm/swagger/llms.txt Use PUT to modify the text of an existing note. Requires note ID. ```bash curl -u "$USER_ID:$API_KEY" \ -X PUT \ -H "Content-Type: application/json" \ -d '{ "text": "Updated: confirmed budget approved." }' \ "https://app.onepagecrm.com/api/v3/notes/5aba31ea9007ba0f570ccc01" ``` -------------------------------- ### Delete and Undo Contact Deletion Source: https://context7.com/onepagecrm/swagger/llms.txt Use the DELETE method to remove a contact. Add `?undo=true` to the request to revert a deletion. ```bash curl -u "$USER_ID:$API_KEY" \ -X DELETE \ "https://app.onepagecrm.com/api/v3/contacts/5aba31e99007ba0f570c92d4" ``` ```bash curl -u "$USER_ID:$API_KEY" \ -X DELETE \ "https://app.onepagecrm.com/api/v3/contacts/5aba31e99007ba0f570c92d4?undo=true" ``` -------------------------------- ### Paginate Contacts Beyond 10,000 Source: https://context7.com/onepagecrm/swagger/llms.txt The cascade endpoint returns batches of 100 contacts and provides a `next_set_url` for cursor-based iteration. A shell loop can be used to retrieve all contacts. ```bash # First batch (no cursor) curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/contacts/cascade" ``` ```bash # Next batch — pass the last contact_id from the previous response LAST_ID="5d2c8ca59b79b2ead94aa425" curl -u "$USER_ID:$API_KEY" \ "https://app.onepagecrm.com/api/v3/contacts/cascade/$LAST_ID" ``` ```bash # Shell loop to drain all contacts last_id="" while true; do url="https://app.onepagecrm.com/api/v3/contacts/cascade${last_id:+/$last_id}" response=$(curl -s -u "$USER_ID:$API_KEY" "$url") echo "$response" | jq '.data.contacts[].contact.id' items_left=$(echo "$response" | jq '.data.items_left') [ "$items_left" -eq 0 ] && break last_id=$(echo "$response" | jq -r '.data.contacts[-1].contact.id') done ``` -------------------------------- ### Enable Status Sync for Company Source: https://context7.com/onepagecrm/swagger/llms.txt Enables status synchronization for all contacts within a company, using a specified status ID. ```APIDOC ## POST /api/v3/companies/{id}/synced_status ### Description Enables status synchronization for contacts within a company. ### Method POST ### Endpoint /api/v3/companies/{id}/synced_status ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the company. #### Request Body - **status_id** (string) - Required - The unique identifier of the status to sync. ### Request Example ```json { "status_id": "5aba31e99007ba0f570c1234" } ``` ### Response #### Success Response (200) (Response details not provided in source) ``` -------------------------------- ### Update Standalone Action Source: https://context7.com/onepagecrm/swagger/llms.txt Updates a specific action, such as marking it as done. Requires the action ID. ```bash curl -u "$USER_ID:$API_KEY" \ -X PUT \ -H "Content-Type: application/json" \ -d '{ "status": "done" }' \ "https://app.onepagecrm.com/api/v3/actions/5aba31ea9007ba0f570c99a1" ``` -------------------------------- ### List Actions for a Contact Source: https://context7.com/onepagecrm/swagger/llms.txt Retrieves all actions associated with a specific contact, with optional status filtering. ```APIDOC ## GET /contacts/{id}/actions ### Description Lists all actions for a specific contact. ### Method GET ### Endpoint `/contacts/{id}/actions` ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the contact. #### Query Parameters - **status** (string) - Optional - Filters actions by status (e.g., 'active'). ``` -------------------------------- ### Rotate API Credentials (Change Auth Key) Source: https://context7.com/onepagecrm/swagger/llms.txt Invalidates the current API key and generates a new one. This action logs the user out of all connected applications and requires immediate credential updates. ```bash curl -u "$USER_ID:$API_KEY" \ -X POST \ "https://app.onepagecrm.com/api/v3/change_auth_key" ``` ```bash # Update your credentials immediately after rotation export API_KEY="wbJBo+odEikiDOjdnL+P+0fl+Dbgk84747jFtyOZghs=" ```