SalesOS

Tasks

Task management and assignment

List

GET
/v1/tasks

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

statusstring
prioritystring
assignedToIdstring
leadIdstring
accountIdstring
contactIdstring
opportunityIdstring
overduestring
sourcestring
pagestring
limitstring
sortBystring
sortOrderstring
searchstring
ownerstring
createdAfterstring
idsstring
openstring
curl -X GET "https://api.salesos.org/v1/tasks?status=%3Cstring%3E&priority=%3Cstring%3E&assignedToId=%3Cstring%3E&leadId=%3Cstring%3E&accountId=%3Cstring%3E&contactId=%3Cstring%3E&opportunityId=%3Cstring%3E&overdue=%3Cstring%3E&source=%3Cstring%3E&page=%3Cstring%3E&limit=%3Cstring%3E&sortBy=%3Cstring%3E&sortOrder=%3Cstring%3E&search=%3Cstring%3E&owner=%3Cstring%3E&createdAfter=%3Cstring%3E&ids=%3Cstring%3E&open=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

TaskList

{
  "data": [
    {
      "id": "string",
      "ownerId": "string",
      "organizationId": "string",
      "assignedToId": "string",
      "leadId": "string",
      "accountId": "string",
      "contactId": "string",
      "opportunityId": "string",
      "meetingSessionId": "string",
      "subject": "string",
      "description": "string",
      "status": "NOT_STARTED",
      "priority": "LOW",
      "dueDate": "2019-08-24T14:15:22Z",
      "reminderDate": "2019-08-24T14:15:22Z",
      "reminderSent": true,
      "completedDate": "2019-08-24T14:15:22Z",
      "metadata": null,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "page": 1,
  "limit": 50,
  "total": 0,
  "totalPages": 0,
  "hasMore": true
}

Create

POST
/v1/tasks

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
subjectRequiredstring
descriptionstring
statusstring
Value in: "COMPLETED" | "IN_PROGRESS" | "NOT_STARTED" | "WAITING" | "DEFERRED"
prioritystring
Value in: "HIGH" | "LOW" | "NORMAL" | "URGENT"
dueDatestring
reminderDatestring
assignedToIdstring
leadIdstring
accountIdstring
contactIdstring
opportunityIdstring
typestring
Value in: "CALL" | "EMAIL" | "MEETING" | "FOLLOW_UP" | "OTHER"

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/tasks" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "string",
    "description": "string",
    "status": "COMPLETED",
    "priority": "HIGH",
    "dueDate": "string",
    "reminderDate": "string",
    "assignedToId": "string",
    "leadId": "string",
    "accountId": "string",
    "contactId": "string",
    "opportunityId": "string",
    "type": "CALL"
  }'

Task

{
  "id": "string",
  "ownerId": "string",
  "organizationId": "string",
  "assignedToId": "string",
  "leadId": "string",
  "accountId": "string",
  "contactId": "string",
  "opportunityId": "string",
  "meetingSessionId": "string",
  "subject": "string",
  "description": "string",
  "status": "NOT_STARTED",
  "priority": "LOW",
  "dueDate": "2019-08-24T14:15:22Z",
  "reminderDate": "2019-08-24T14:15:22Z",
  "reminderSent": true,
  "completedDate": "2019-08-24T14:15:22Z",
  "metadata": null,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Get stats

GET
/v1/tasks/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/tasks/stats" \
  -H "Authorization: Bearer <token>"

Find one

GET
/v1/tasks/{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/tasks/<string>" \
  -H "Authorization: Bearer <token>"

Task

{
  "id": "string",
  "ownerId": "string",
  "organizationId": "string",
  "assignedToId": "string",
  "leadId": "string",
  "accountId": "string",
  "contactId": "string",
  "opportunityId": "string",
  "meetingSessionId": "string",
  "subject": "string",
  "description": "string",
  "status": "NOT_STARTED",
  "priority": "LOW",
  "dueDate": "2019-08-24T14:15:22Z",
  "reminderDate": "2019-08-24T14:15:22Z",
  "reminderSent": true,
  "completedDate": "2019-08-24T14:15:22Z",
  "metadata": null,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Update

PATCH
/v1/tasks/{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

Request Body

application/jsonRequired
subjectstring
descriptionstring
statusstring
Value in: "COMPLETED" | "IN_PROGRESS" | "NOT_STARTED" | "WAITING" | "DEFERRED"
prioritystring
Value in: "HIGH" | "LOW" | "NORMAL" | "URGENT"
dueDatestring
reminderDatestring
completedDatestring
assignedToIdstring
leadIdstring
accountIdstring
contactIdstring
opportunityIdstring
typestring
Value in: "CALL" | "EMAIL" | "MEETING" | "FOLLOW_UP" | "OTHER"

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 PATCH "https://api.salesos.org/v1/tasks/<string>" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "string",
    "description": "string",
    "status": "COMPLETED",
    "priority": "HIGH",
    "dueDate": "string",
    "reminderDate": "string",
    "completedDate": "string",
    "assignedToId": "string",
    "leadId": "string",
    "accountId": "string",
    "contactId": "string",
    "opportunityId": "string",
    "type": "CALL"
  }'

Task

{
  "id": "string",
  "ownerId": "string",
  "organizationId": "string",
  "assignedToId": "string",
  "leadId": "string",
  "accountId": "string",
  "contactId": "string",
  "opportunityId": "string",
  "meetingSessionId": "string",
  "subject": "string",
  "description": "string",
  "status": "NOT_STARTED",
  "priority": "LOW",
  "dueDate": "2019-08-24T14:15:22Z",
  "reminderDate": "2019-08-24T14:15:22Z",
  "reminderSent": true,
  "completedDate": "2019-08-24T14:15:22Z",
  "metadata": null,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Remove

DELETE
/v1/tasks/{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/tasks/<string>" \
  -H "Authorization: Bearer <token>"

No response body.

Complete

POST
/v1/tasks/{id}/complete

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/tasks/<string>/complete" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>"

Task

{
  "id": "string",
  "ownerId": "string",
  "organizationId": "string",
  "assignedToId": "string",
  "leadId": "string",
  "accountId": "string",
  "contactId": "string",
  "opportunityId": "string",
  "meetingSessionId": "string",
  "subject": "string",
  "description": "string",
  "status": "NOT_STARTED",
  "priority": "LOW",
  "dueDate": "2019-08-24T14:15:22Z",
  "reminderDate": "2019-08-24T14:15:22Z",
  "reminderSent": true,
  "completedDate": "2019-08-24T14:15:22Z",
  "metadata": null,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Pipelines

Sales pipeline configuration

Cases

Customer service cases and comments