Skip to content

Get a lead

Retrieves a single lead by ID, with all fields. Optionally includes a paginated slice of the lead's actions when includeActions=true. Without that flag, the response contains only fields — use search actions for finer-grained timeline queries.

Request

FieldValue
MethodGET
URLhttps://next.telecrm.in/autoupdate/v2/enterprise/{enterpriseId}/lead/{leadId}
AuthBearer token (Sync-typed). See Authentication.

Path parameters

NameTypeRequiredDescription
enterpriseIdstringyesThe enterprise (workspace) ID.
leadIdstringyesThe lead's ID, as returned by POST /lead or search results.

Query parameters

NameTypeDefaultDescription
includeActionsbooleanfalseWhen true, include a paginated actions array in the response.
skipinteger0Action pagination offset. Ignored when includeActions=false.
limitinteger10Maximum number of actions to return (1-100). Ignored when includeActions=false.

Example request

bash
curl "https://next.telecrm.in/autoupdate/v2/enterprise/{enterpriseId}/lead/603d2b2f9b1e8a001c8e4f5c?includeActions=true&limit=5" \
  -H "Authorization: Bearer YOUR_SYNC_TOKEN"

Responses

200 OK

json
{
  "fields": {
    "name": "Jane Doe",
    "phone": "919999999999",
    "email": "jane.doe@example.com",
    "status": "Fresh",
    "rating": 4
  },
  "actions": [
    {
      "type": "1001",
      "fields": { "note": "Site visit completed" }
    }
  ],
  "actions_skip": 0,
  "actions_limit": 5
}

When includeActions=false, the actions, actions_skip, and actions_limit keys are omitted.

400 Bad Request

Invalid query parameter values.

json
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Limit should be between 1 and 100"
  }
}

401 Unauthorized

See the universal 401 in the overview.

404 Not Found

json
{
  "error": {
    "code": "LEAD_NOT_FOUND",
    "message": "The lead with ID 62ab16e was not found."
  }
}

Notes

  • The actions slice returned here covers all action types on the lead's timeline, including read-only types like calls and system events. See Action Types for the full enum.
  • Use POST /lead/{leadId}/action/search when you need to filter the timeline by type, performer, or date range.