groups

Embed
Preview of the card
<a href="https://lucida.15-204-158-166.sslip.io/docs/ref-groups"><img src="https://lucida.15-204-158-166.sslip.io/docs/_api/public/orgs/af34862a-c837-4478-8335-0505efe40459/spaces/da916cd3-c0fc-4b63-b971-b3c13623daf3/pages/c5eb9e18-8672-4d6b-badb-d682f7a5f14f/social-card.svg?v=3e7ae33eec8b" alt="groups" width="600" height="315"></a>
DELETEhttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/account-relationships/{id}

Parameters

project_idstringpathrequired
idstringpathrequired

Code samples

cURL
curl -X DELETE "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/account-relationships/{id}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

204
404
PATCHhttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/account-relationships/{id}

Parameters

project_idstringpathrequired
idstringpathrequired

Request body

application/json
ends_onstring
Last day of the relationship; null makes it ongoing again.
{
  "ends_on": "string"
}

Code samples

cURL
curl -X PATCH "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/account-relationships/{id}" \
  -H "Content-Type: application/json" \
  -d '{"ends_on":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

204
404
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/account-tasks

Parameters

project_idstringpathrequired
statusstringquery
assigneestringquery
A user id, or me
limitintegerquery
cursorstringquery

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/account-tasks"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Page of Task across accounts, newest first
400
404
DELETEhttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/account-tasks/{id}

Parameters

project_idstringpathrequired
idstringpathrequired

Code samples

cURL
curl -X DELETE "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/account-tasks/{id}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

204
404
PATCHhttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/account-tasks/{id}

Parameters

project_idstringpathrequired
idstringpathrequired

Request body

application/json

Fields to change; absent ones are kept. assignee_id / due_on set to null clear them.

assignee_idstring
due_onstring
notesstring
statusstring
titlestring
{
  "assignee_id": "string",
  "due_on": "string",
  "notes": "string",
  "status": "string",
  "title": "string"
}

Code samples

cURL
curl -X PATCH "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/account-tasks/{id}" \
  -H "Content-Type: application/json" \
  -d '{"assignee_id":"string","due_on":"string","notes":"string","status":"string","title":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200
Example
{
  "assignee_id": "string",
  "created_at": "2024-01-01T00:00:00Z",
  "created_by": "string",
  "done_at": "2024-01-01T00:00:00Z",
  "due_on": "string",
  "group_key": "string",
  "group_type_index": 0,
  "id": "string",
  "notes": "string",
  "status": "string",
  "title": "string",
  "updated_at": "2024-01-01T00:00:00Z"
}
Schema
assignee_idstring
created_atstringrequired
created_bystring
done_atstring
due_onstring
group_keystringrequired
group_type_indexintegerrequired
idstringrequired
notesstringrequired
statusstringrequired
open | done
titlestringrequired
updated_atstringrequired
400
404
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/group_types

Parameters

project_idstringpathrequired

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/group_types"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Page of GroupType (at most 5, no further pages)
404
PATCHhttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/group_types/{type_index}

Parameters

project_idstringpathrequired
type_indexintegerpathrequired

Request body

application/json

Display names; blank or null clears one.

name_pluralstring
name_singularstring
{
  "name_plural": "string",
  "name_singular": "string"
}

Code samples

cURL
curl -X PATCH "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/group_types/{type_index}" \
  -H "Content-Type: application/json" \
  -d '{"name_plural":"string","name_singular":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200
Example
{
  "group_type": "string",
  "group_type_index": 0,
  "name_plural": "string",
  "name_singular": "string"
}
Schema
group_typestringrequired
group_type_indexintegerrequired
name_pluralstring
name_singularstring
Display names set in the app ("Company" / "Companies"); unset = the raw type.
400
403
404
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/groups

Parameters

project_idstringpathrequired
type_indexintegerqueryrequired
qstringquery
limitintegerquery
cursorstringquery

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/groups?type_index=<type_index>"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Page of Group, newest first
400
404
503
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/groups/export.csv

Parameters

project_idstringpathrequired
type_indexintegerqueryrequired

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/groups/export.csv?type_index=<type_index>"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 group_type_index,key,created_at,properties; newest first, streamed, capped
"string"
400
404
503
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/groups/{type_index}/{key}

Parameters

project_idstringpathrequired
type_indexintegerpathrequired
keystringpathrequired

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/groups/{type_index}/{key}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200
Example
{
  "created_at": "string",
  "group_type_index": 0,
  "key": "string",
  "properties": {},
  "event_count": 0,
  "first_seen": "string",
  "group_type": "string",
  "last_seen": "string",
  "person_count": 0
}
Schema
created_atstringrequired
group_type_indexintegerrequired
keystringrequired
propertiesobjectrequired
event_countintegerrequired
first_seenstring
group_typestring
Registered name of the group type (company).
last_seenstring
person_countintegerrequired
Distinct people seen acting for the group.
400
404
503
PATCHhttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/groups/{type_index}/{key}

Parameters

project_idstringpathrequired
type_indexintegerpathrequired
keystringpathrequired

Request body

application/json

Properties to set (replacing values) and keys to remove; at most 100 keys in all.

setobject
unsetstring[]
{
  "set": {},
  "unset": [
    "string"
  ]
}

Code samples

cURL
curl -X PATCH "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/groups/{type_index}/{key}" \
  -H "Content-Type: application/json" \
  -d '{"set":{},"unset":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

202 written at once; with an event queue the worker also re-applies the edit in order with SDK group writes
Example
{
  "properties": {}
}
Schema
propertiesobjectrequired
400
403
404
503

Updated