TRANXACT.AI Help

CRM · Relationships

Activities

Calls, e-mails, meetings and notes logged against a customer, a contact or an opportunity, and what is still to do.

Type REST9 operationsBase path /api/crm/activitiesPublished as /api/v1/activities

Download specification (OpenAPI 3.1) Screen: Activities

Overview

PackageCRM
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold CRM › Activities on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tablecrm.activities · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

9 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/crm/activitiesList activities

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "activity_type": "call",
      "subject": "text",
      "due_at": "2026-10-30T09:00:00Z",
      "status": "open",
      "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "notes": "text",
      "created_at": "2026-10-30T09:00:00Z",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/crm/activities?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/activities/{id}Read one activities

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "activity_type": "call",
  "subject": "text",
  "due_at": "2026-10-30T09:00:00Z",
  "status": "open",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "notes": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/crm/activities/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/activitiesCreate a activities

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
activity_typetextNoType
Allowed: call email meeting note task visit
subjecttextYesSubject
due_attimestamp with time zoneNoWhen
statustextNoStatus
Allowed: open done cancelled
account_iduuidNoAccount
contact_iduuidNoContact
opportunity_iduuidNoOpportunity id
notestextNoNotes

Sample body

{
  "subject": "text",
  "activity_type": "call",
  "due_at": "2026-10-30T09:00:00Z",
  "status": "open",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "activity_type": "call",
  "subject": "text",
  "due_at": "2026-10-30T09:00:00Z",
  "status": "open",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "notes": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/activities" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"subject":"text","activity_type":"call","due_at":"2026-10-30T09:00:00Z","status":"open","account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/crm/activities/{id}Change a activities

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
activity_typetextNoType
Allowed: call email meeting note task visit
subjecttextYesSubject
due_attimestamp with time zoneNoWhen
statustextNoStatus
Allowed: open done cancelled
account_iduuidNoAccount
contact_iduuidNoContact
opportunity_iduuidNoOpportunity id
notestextNoNotes

Sample body

{
  "subject": "text",
  "activity_type": "call"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "activity_type": "call",
  "subject": "text",
  "due_at": "2026-10-30T09:00:00Z",
  "status": "open",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "notes": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/crm/activities/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"subject":"text","activity_type":"call"}'
DELETE/api/crm/activities/{id}Delete a activities

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/crm/activities/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/activities/{id}/calendar-inviteCalendar invite

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/activities/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/calendar-invite" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/activities/{id}/calendar-invite/cancelCalendar invite cancel

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/activities/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/calendar-invite/cancel" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/activities/{id}/push-to-calendarPush to calendar

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/activities/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/push-to-calendar" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/activities/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/activities/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a activities, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
activity_typetextread, writeType
Allowed: call email meeting note task visit
subjecttextread, writeSubject
due_attimestamp with time zoneread, writeWhen
statustextread, writeStatus
Allowed: open done cancelled
account_iduuidread, writeAccount
contact_iduuidread, writeContact
opportunity_iduuidread, writeOpportunity id
owner_iduuidread onlyOwner id
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
location_iduuidread onlyLocation id
warehouse_iduuidread onlyWarehouse id
lead_iduuidread onlyLead id
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
sourcetextread onlySource
external_idtextread onlyExternal id
mailbox_connection_iduuidread onlyMailbox connection id
directiontextread onlyDirection
from_addresstextread onlyFrom address
to_addressestextread onlyTo addresses
body_texttextread onlyBody text
starts_attimestamp with time zoneread onlyStarts at
ends_attimestamp with time zoneread onlyEnds at
location_texttextread onlyLocation text
calendar_event_idtextread onlyCalendar event id
calendar_pushed_attimestamp with time zoneread onlyCalendar pushed at
calendar_push_errortextread onlyCalendar push error

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold CRM › Activities for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.