SalesOS

Activities

Activity tracking and logging

List

GET
/v1/activities

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Query Parameters

typestring
leadIdstring
accountIdstring
contactIdstring
opportunityIdstring
startDatestring
endDatestring
limitstring
pagestring
sortBystring
sortOrderstring
curl -X GET "https://api.salesos.org/v1/activities?type=%3Cstring%3E&leadId=%3Cstring%3E&accountId=%3Cstring%3E&contactId=%3Cstring%3E&opportunityId=%3Cstring%3E&startDate=%3Cstring%3E&endDate=%3Cstring%3E&limit=%3Cstring%3E&page=%3Cstring%3E&sortBy=%3Cstring%3E&sortOrder=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

ActivityList

{
  "data": [
    {
      "id": "string",
      "userId": "string",
      "organizationId": "string",
      "leadId": "string",
      "accountId": "string",
      "contactId": "string",
      "opportunityId": "string",
      "conversationId": "string",
      "meetingSessionId": "string",
      "type": "CALL",
      "subject": "string",
      "description": "string",
      "outcome": "string",
      "sentiment": "VERY_POSITIVE",
      "activityDate": "2019-08-24T14:15:22Z",
      "duration": 0,
      "keyPoints": [
        "string"
      ],
      "actionItems": [
        "string"
      ],
      "concerns": [
        "string"
      ],
      "nextSteps": [
        "string"
      ],
      "metadata": null,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "emailThreadId": "string"
    }
  ],
  "page": 1,
  "limit": 50,
  "total": 0,
  "totalPages": 0,
  "hasMore": true
}

Create

POST
/v1/activities

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Request Body

application/jsonRequired
typeRequiredstring
Value in: "OTHER" | "WEBINAR" | "EMAIL" | "DEMO" | "CALL" | "MEETING" | "PRESENTATION" | "PROPOSAL_SENT" | "CONTRACT_SENT" | "FOLLOW_UP" | "RESEARCH" | "INTERNAL_NOTE" | "LINKEDIN_MESSAGE" | "SITE_VISIT"
subjectRequiredstring
descriptionstring
outcomestring
activityDatestring
durationnumber
leadIdstring
accountIdstring
contactIdstring
opportunityIdstring
conversationIdstring

Header Parameters

Idempotency-Keystring

Unique key (a UUID is ideal) that makes this write safe to retry for 24 hours: a retry with the same body replays the original response (Idempotent-Replayed: true); the same key with a different body is a 409.

Maximum length: 255
curl -X POST "https://api.salesos.org/v1/activities" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "OTHER",
    "subject": "string",
    "description": "string",
    "outcome": "string",
    "activityDate": "string",
    "duration": 0,
    "leadId": "string",
    "accountId": "string",
    "contactId": "string",
    "opportunityId": "string",
    "conversationId": "string"
  }'

Activity

{
  "id": "string",
  "userId": "string",
  "organizationId": "string",
  "leadId": "string",
  "accountId": "string",
  "contactId": "string",
  "opportunityId": "string",
  "conversationId": "string",
  "meetingSessionId": "string",
  "type": "CALL",
  "subject": "string",
  "description": "string",
  "outcome": "string",
  "sentiment": "VERY_POSITIVE",
  "activityDate": "2019-08-24T14:15:22Z",
  "duration": 0,
  "keyPoints": [
    "string"
  ],
  "actionItems": [
    "string"
  ],
  "concerns": [
    "string"
  ],
  "nextSteps": [
    "string"
  ],
  "metadata": null,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "emailThreadId": "string"
}

Get stats

GET
/v1/activities/stats

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

curl -X GET "https://api.salesos.org/v1/activities/stats" \
  -H "Authorization: Bearer <token>"

Get activity count

GET
/v1/activities/count

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Query Parameters

datestring
typestring
curl -X GET "https://api.salesos.org/v1/activities/count?date=%3Cstring%3E&type=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Get timeline

GET
/v1/activities/timeline/{recordType}/{recordId}

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Path Parameters

recordTypeRequiredstring
recordIdRequiredstring
curl -X GET "https://api.salesos.org/v1/activities/timeline/<string>/<string>" \
  -H "Authorization: Bearer <token>"

[
  {}
]

Find one

GET
/v1/activities/{id}

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Path Parameters

idRequiredstring
curl -X GET "https://api.salesos.org/v1/activities/<string>" \
  -H "Authorization: Bearer <token>"

Activity

{
  "id": "string",
  "userId": "string",
  "organizationId": "string",
  "leadId": "string",
  "accountId": "string",
  "contactId": "string",
  "opportunityId": "string",
  "conversationId": "string",
  "meetingSessionId": "string",
  "type": "CALL",
  "subject": "string",
  "description": "string",
  "outcome": "string",
  "sentiment": "VERY_POSITIVE",
  "activityDate": "2019-08-24T14:15:22Z",
  "duration": 0,
  "keyPoints": [
    "string"
  ],
  "actionItems": [
    "string"
  ],
  "concerns": [
    "string"
  ],
  "nextSteps": [
    "string"
  ],
  "metadata": null,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "emailThreadId": "string"
}

Remove

DELETE
/v1/activities/{id}

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Path Parameters

idRequiredstring
curl -X DELETE "https://api.salesos.org/v1/activities/<string>" \
  -H "Authorization: Bearer <token>"

No response body.

Extract insights

POST
/v1/activities/{id}/extract-insights

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Path Parameters

idRequiredstring

Header Parameters

Idempotency-Keystring

Unique key (a UUID is ideal) that makes this write safe to retry for 24 hours: a retry with the same body replays the original response (Idempotent-Replayed: true); the same key with a different body is a 409.

Maximum length: 255
curl -X POST "https://api.salesos.org/v1/activities/<string>/extract-insights" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>"

Activity

{
  "id": "string",
  "userId": "string",
  "organizationId": "string",
  "leadId": "string",
  "accountId": "string",
  "contactId": "string",
  "opportunityId": "string",
  "conversationId": "string",
  "meetingSessionId": "string",
  "type": "CALL",
  "subject": "string",
  "description": "string",
  "outcome": "string",
  "sentiment": "VERY_POSITIVE",
  "activityDate": "2019-08-24T14:15:22Z",
  "duration": 0,
  "keyPoints": [
    "string"
  ],
  "actionItems": [
    "string"
  ],
  "concerns": [
    "string"
  ],
  "nextSteps": [
    "string"
  ],
  "metadata": null,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "emailThreadId": "string"
}

Cases

Customer service cases and comments

Notes

Notes on records