--- updatedAt: 2026-08-21T15:09:17.000Z agentTools: projectIndex: https://salesrabbit.readme.io/llms.txt --- # Get status history for a lead See how a single lead has moved through your pipeline. Returns a flat list of `lead_status_history_item` records in JSON:API format, one per status change. By default the full history is returned, ordered oldest-first by `initiated_at`. Supports pagination and time-range filtering. # OpenAPI definition ```json { "components": { "securitySchemes": { "bearerAuth": { "description": "Your API key can be found in your SalesRabbit account settings. Include it in the Authorization header as: `Bearer YOUR_API_KEY`", "in": "header", "name": "Authorization", "type": "apiKey" } } }, "info": { "contact": { "email": "api-support@salesrabbit.com", "name": "SalesRabbit API Support", "url": "https://www.salesrabbit.com/support" }, "description": "The SalesRabbit+ API Gateway allows you to integrate your tools and data with SalesRabbit's field sales platform.\n\n## What You Can Do\n\nWith this API, you can:\n\n- **Manage leads** throughout your sales pipeline\n- **Schedule appointments** and sync them with calendars\n- **Organize territories** for your field sales team\n- **Track contacts** with phone numbers and emails\n- **Customize data** with custom fields specific to your industry\n- **Control access** with user profiles and roles\n- **Monitor progress** through pipeline statuses\n\n## Getting Started\n\n1. Get your API key from your SalesRabbit account settings\n2. Include it in the `Authorization` header: `Bearer YOUR_API_KEY`\n3. Make requests to `https://integrate.salesrabbit.com`\n\n## Understanding Leads\n\nIn SalesRabbit, a **lead** represents a potential customer opportunity. Each lead:\n- Has contact information (name, address, phone, email)\n- Belongs to a pipeline status (e.g., \"New\", \"Pitched\", \"Closed\")\n- Can be assigned to a sales rep\n- May have appointments, notes, and custom data attached\n- Exists within a geographic area/territory\n\nLeads are the central object that connects contacts, appointments, notes, and your sales process together.\n\n## Data Format\n\nWe use the [JSON:API specification](https://jsonapi.org/), which means:\n- Consistent structure across all endpoints\n- Easy to include related data in one request\n- Powerful filtering and sorting options\n- Pagination built-in for large datasets\n\nNew to JSON:API? Don't worry - our examples show you exactly how to format requests.\n\n## Glossary\n\nNew to field sales or SalesRabbit? Check out the glossary for definitions of key terms like Lead, Pipeline, Status, and more. Glossary terms appear throughout this documentation with helpful tooltips.", "license": { "name": "Proprietary", "url": "https://www.salesrabbit.com/terms" }, "title": "SalesRabbit+ API Gateway", "version": "1.0", "x-logo": { "altText": "SalesRabbit Logo", "url": "https://www.salesrabbit.com/wp-content/uploads/2023/01/SalesRabbit-logo.png" } }, "openapi": "3.0.0", "paths": { "/v1/leads/{id}/status_history": { "get": { "description": "See how a single lead has moved through your pipeline. Returns a flat list of `lead_status_history_item` records in JSON:API format, one per status change. By default the full history is returned, ordered oldest-first by `initiated_at`. Supports pagination and time-range filtering.", "operationId": "getLeadsByIdStatusHistory", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "value": { "data": [ { "attributes": { "abbreviation": "IML", "action": "update", "distance": null, "initiated_at": "2025-10-23T06:47:33.622380", "initiated_by": "f59dbf2f-6ebe-4a68-96cb-e72cdba3a7a7", "inserted_at": "2025-10-23T06:47:33.622481", "lead_id": "5399c5ee-ca3f-49bf-906c-88044464268d", "lead_status_id": "afe109cc-4cfa-48d4-bf77-f198e449663a", "name": "stage-tenant-1-4", "status": "active" }, "id": "019a0fd2-a1f6-76fb-8a63-a2f584e789a7", "relationships": { "lead": {} }, "type": "lead_status_history_item" }, { "attributes": { "abbreviation": "+08", "action": "update", "distance": null, "initiated_at": "2025-10-23T19:47:55.328521", "initiated_by": "f59dbf2f-6ebe-4a68-96cb-e72cdba3a7a7", "inserted_at": "2025-10-23T19:47:55.328656", "lead_id": "5399c5ee-ca3f-49bf-906c-88044464268d", "lead_status_id": "259fdfd6-0d3c-490e-a48b-df0741418c91", "name": "stage-tenant-1-3", "status": "active" }, "id": "019a129d-1340-7b8a-86b5-868a1f85151e", "relationships": { "lead": {} }, "type": "lead_status_history_item" } ], "jsonapi": { "version": "1.0" }, "links": { "first": "{host}/leads/5399c5ee-ca3f-49bf-906c-88044464268d/status_history?page[limit]=30&sort=initiated_at", "next": null, "prev": null, "self": "{host}/leads/5399c5ee-ca3f-49bf-906c-88044464268d/status_history?page[limit]=30&sort=initiated_at" }, "meta": { "page": {} } } } } } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "example": { "value": { "errors": [ { "code": "something_went_wrong", "detail": "Something went wrong. Error id: b2a912fa-884c-47cb-a3a0-3e04a05d575e", "id": "b2a912fa-884c-47cb-a3a0-3e04a05d575e", "status": "400", "title": "SomethingWentWrong" } ], "jsonapi": { "version": "1.0" } } } } } }, "description": "" }, "401": { "content": { "application/json": { "examples": { "example": { "value": { "error": "Unauthorized - Invalid or missing authentication" } } } } }, "description": "" }, "403": { "content": { "application/json": { "examples": { "example": { "value": { "error": "Forbidden - Insufficient permissions" } } } } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "example": { "value": { "errors": [ { "code": "not_found", "detail": "Lead not found", "id": "4c8d3fb6-0a59-4e89-ad68-841f8e5d44b7", "meta": {}, "status": "404", "title": "Entity Not Found" } ], "jsonapi": { "version": "1.0" } } } } } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "example": { "value": { "error": "Internal Server Error" } } } } }, "description": "" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get status history for a lead", "tags": [ "Leads" ] } } }, "servers": [ { "description": "Production server (US)", "url": "https://integrate.salesrabbit.com" }, { "description": "Production server (Ireland)", "url": "https://integrate.ireland.salesrabbit.com" } ], "tags": [ { "description": "The heart of your sales operation. Leads represent potential customers as your reps move them through your sales pipeline from first contact to closed deal.", "externalDocs": { "description": "Learn about Lead Management", "url": "https://www.salesrabbit.com/lead-generation" }, "name": "Leads" } ], "x-readme": { "explorer-enabled": true, "glossary": [ { "definition": "A potential customer opportunity in your sales pipeline. Each lead represents a person or household that your sales team is working to convert into a customer. Leads contain contact information, location data, pipeline status, and custom fields specific to your business.", "term": "Lead" }, { "definition": "A step in your sales pipeline that represents where a lead is in the sales process. Common statuses include 'New', 'Contacted', 'Pitched', 'Follow-up', 'Closed Won', and 'Closed Lost'. You can customize statuses to match your specific sales process.", "term": "Status" }, { "definition": "The series of statuses that leads move through from first contact to becoming a customer (or being marked as lost). Your pipeline gives you visibility into where opportunities are in the sales process and helps forecast revenue.", "term": "Pipeline" }, { "definition": "A geographic territory or region assigned to your sales team. Areas help organize field sales operations by defining boundaries where specific reps or teams will generate and work leads. Also called territories.", "term": "Area" }, { "definition": "Another name for an Area. A geographic region assigned to sales reps for prospecting and lead generation. Territories help ensure complete market coverage without overlap between reps.", "term": "Territory" }, { "definition": "Short for Sales Representative. The field sales team member assigned to work leads, make appointments, and close deals. In the API, reps are referred to by their Profile ID.", "term": "Rep" }, { "definition": "A scheduled meeting between a sales rep and a lead. Appointments in SalesRabbit sync with calendars and are tied to specific leads, helping reps stay organized and follow up consistently.", "term": "Appointment" }, { "definition": "The person information associated with a lead, including name and methods of communication. A contact can have multiple phone numbers and email addresses. The same contact can be associated with multiple leads (e.g., different household members).", "term": "Contact" }, { "definition": "Additional data fields you create to capture information specific to your industry or sales process. Examples include roof type for solar/roofing companies, system size, HOA approval status, etc. Custom fields can be text, numbers, dropdowns, dates, or checkboxes.", "term": "Custom Field" }, { "definition": "An organizational unit for managing your sales team. Teams can represent offices, regions, or any hierarchy that matches your business structure. teams can be nested (e.g., Region > Office > Team) and are used for permissions, reporting, and lead assignment.", "term": "Team" }, { "definition": "A user account in SalesRabbit. Each profile represents a person with access to your organization's data. Profiles have roles that determine what they can see and do in the system. Also referred to as a user.", "term": "Profile" }, { "definition": "A set of permissions that determines what a user can do in SalesRabbit. Common roles include Admin (full access), Manager (team oversight), and Rep (field sales). Roles control access to features, data visibility, and administrative functions.", "term": "Role" }, { "definition": "A specification for building APIs that defines conventions for requests and responses. The SalesRabbit API follows JSON:API standards, which means you can use features like including related resources, filtering, sorting, and pagination in a consistent way across all endpoints.", "term": "JSON:API" }, { "definition": "An automated process that triggers actions based on events in SalesRabbit. Stages help ensure consistency, automate follow-ups, and reduce manual work when tracking information in Amplify.", "term": "Stage" }, { "definition": "A comment or update added to a lead. Notes help teams share information about conversations, objections, follow-up needs, and other context. Notes are timestamped and attributed to the user who created them.", "term": "Lead Note" }, { "definition": "The sales rep (profile) currently responsible for working a lead. Leads can be reassigned to different reps as areas change or workload needs to be balanced.", "term": "Assignee" }, { "definition": "Query parameters used to narrow down API results based on specific criteria. For example, filtering leads by city, status, or date range. Filters use the format `filter[field]=value` in API requests.", "term": "Filter" }, { "definition": "A JSON:API feature that lets you request related resources in the same API call. For example, when getting a lead, you can include its contact information, status details, and assigned rep in one request using `include=contacts,lead_status,assignee`.", "term": "Include" }, { "definition": "The practice of breaking large result sets into smaller pages. The API uses `page[limit]` and `page[offset]` parameters to control how many results are returned and where to start in the result set.", "term": "Pagination" }, { "definition": "A JSON:API feature that lets you request only specific fields instead of the full resource. Use `fields[type]=field1,field2` to reduce response size and improve performance when you don't need all data.", "term": "Sparse Fieldsets" }, { "definition": "Universally Unique Identifier. A 36-character string used to uniquely identify resources in the API (e.g., `123e4567-e89b-12d3-a456-426614174000`). UUIDs are used for leads, profiles, statuses, and other resources.", "term": "UUID" }, { "definition": "Sales activities conducted in person, typically door-to-door or at customer locations rather than remotely. SalesRabbit is designed specifically for field sales teams in industries like solar, roofing, pest control, and telecommunications.", "term": "Field Sales" }, { "definition": "A sales approach where reps visit homes in person to generate leads and make pitches. Also called D2D or canvassing. SalesRabbit helps D2D teams with territory mapping, lead tracking, and route optimization.", "term": "Door-to-Door" }, { "definition": "The process of going door-to-door in a neighborhood to generate leads and schedule appointments. SalesRabbit provides tools for mapping canvassing routes, tracking which doors have been knocked, and managing generated leads.", "term": "Canvassing" } ], "proxy-enabled": true, "samples-enabled": true, "samples-languages": [ "curl", "node", "python", "ruby", "php", "java", "csharp" ] } } ```