Activities

API Endpoints for Activities

List Activities get

https://relatecrm.example.com/api/activities

Headers Required headers
Content-Type (Required) string application/json
Accept (Required) string application/json
Authorization (Required) string Bearer {token}

Query Parameters
order (Optional) string Sort the results being queried.
Example: ?order=created_at or ?order=created_at\|desc
select (Optional) string Select only the provided fields, useful for query optimization.
Example: ?select=first_name;id
per_page (Optional) integer Provide the total number of records to query per page.
Example: ?per_page=20
page (Optional) integer The page number to retrieve results for.
Example: ?page=2
q (Optional) string Search records by a given query.
Example: ?q=John
search_fields (Optional) string Change the fields that the search will be performed to
Example:?search_fields=email:like;phones.number:=
search_match (Optional) string By default the search queries are performed using the OR comparison operator for each query parameter, if you need to match all parameters, you will need to use the AND comparison operator.
Example: ?search_match=and

Retrieve Activity get

https://relatecrm.example.com/api/activities/{id}

Headers Required headers
Content-Type (Required) string application/json
Accept (Required) string application/json
Authorization (Required) string Bearer {token}

Path Parameters
id (Required) integer The ID of the record

Create Activity post

https://relatecrm.example.com/api/activities

Headers Required headers
Content-Type (Required) string application/json
Accept (Required) string application/json
Authorization (Required) string Bearer {token}

Body Parameters
title (Required) string
activity_type_id (Optional) integer ID of the activity type

If not provided, the default selected activity type in Settings->Activities will be used.
user_id (Required) integer The owner/assigned of the activity
note (Optional) string
description (Optional) string
due_date (Required) date Activity due date in UTC format

Example:
Only date: 2021-05-04
With time: 2021-05-04 10:00:00
end_date (Optional) date Activity end date in UTC format

Example:
Only date: 2021-05-05
With time: 2021-05-05 10:00:00

When creating activity, if not provided, the activity due date will be used as end date.
reminder_minutes_before (Optional) integer Minutes to send reminder before the due date
guests (Optional) array Example:

[
"users" => [2, 3],
"contacts" => [4, 5],
]
contacts (Optional) array Array of contact ID's the activity is associated with.
companies (Optional) array Array of company ID's the activity is associated with.
deals (Optional) array Array of deal ID's the activity is associated with.

Update Activity put

https://relatecrm.example.com/api/activities/{id}

Headers Required headers
Content-Type (Required) string application/json
Accept (Required) string application/json
Authorization (Required) string Bearer {token}

Path Parameters
id (Required) integer The ID of the record

Body Parameters
title (Required) string
activity_type_id (Optional) integer ID of the activity type

If not provided, the default selected activity type in Settings->Activities will be used.
user_id (Optional) integer The owner/assigned of the activity
note (Optional) string
description (Optional) string
due_date (Optional) date Activity due date in UTC format

Example:
Only date: 2021-05-04
With time: 2021-05-04 10:00:00
end_date (Optional) date Activity end date in UTC format

Example:
Only date: 2021-05-05
With time: 2021-05-05 10:00:00

When creating activity, if not provided, the activity due date will be used as end date.
reminder_minutes_before (Optional) integer Minutes to send reminder before the due date
guests (Optional) array Example:

[
"users" => [2, 3],
"contacts" => [4, 5],
]
contacts (Optional) array Array of contact ID's the activity is associated with.
companies (Optional) array Array of company ID's the activity is associated with.
deals (Optional) array Array of deal ID's the activity is associated with.

Delete Activity delete

https://relatecrm.example.com/api/activities/{id}

Headers Required headers
Content-Type (Required) string application/json
Accept (Required) string application/json
Authorization (Required) string Bearer {token}

Path Parameters
id (Required) integer The ID of the record

Search Activities get

https://relatecrm.example.com/api/activities/search?q={query}

Use this endpoint to perform search without pagination and use the take parameter if you need to limit the results.

Headers Required headers
Content-Type (Required) string application/json
Accept (Required) string application/json
Authorization (Required) string Bearer {token}

Path Parameters
q (Required) string

Query Parameters
take (Optional) integer The maximum number of results to query
Example: ?take=1
order (Optional) string Sort the results being queried.
Example: ?order=created_at or ?order=created_at\|desc
select (Optional) string Select only the provided fields, useful for query optimization.
Example: ?select=first_name;id
search_fields (Optional) string Change the fields that the search will be performed to
Example:?search_fields=email:like;phones.number:=
search_match (Optional) string By default the search queries are performed using the OR comparison operator for each query parameter, if you need to match all parameters, you will need to use the AND comparison operator.
Example: ?search_match=and

Attach Associations to Activity put

https://relatecrm.example.com/api/associations/activities/{id}

Headers Required headers
Content-Type (Required) string application/json
Accept (Required) string application/json
Authorization (Required) string Bearer {token}

Path Parameters
id (Required) integer The ID of the record

Make sure to provide at least one resource.

Body Parameters
contacts (Optional) array Array of contacts ID's to attach
companies (Optional) array Array of companies ID's to attach
deals (Optional) array Array of deals ID's to attach

Detach Associations From Activity delete

https://relatecrm.example.com/api/associations/activities/{id}

Headers Required headers
Content-Type (Required) string application/json
Accept (Required) string application/json
Authorization (Required) string Bearer {token}

Path Parameters
id (Required) integer The ID of the record

Make sure to provide at least one resource.

Body Parameters
contacts (Optional) array Array of contacts ID's to detach
companies (Optional) array Array of companies ID's to detach
deals (Optional) array Array of deals ID's to detach

Sync Associations To Activity post

https://relatecrm.example.com/api/associations/activities/{id}

Headers Required headers
Content-Type (Required) string application/json
Accept (Required) string application/json
Authorization (Required) string Bearer {token}

Path Parameters
id (Required) integer The ID of the record

Make sure to provide at least one resource.

Body Parameters
contacts (Optional) array Array of contacts ID's to sync
companies (Optional) array Array of companies ID's to sync
deals (Optional) array Array of deals ID's to sync

Change Activity Status post

https://relatecrm.example.com/api/activities/{id}/{status}

Headers Required headers
Content-Type (Required) string application/json
Accept (Required) string application/json
Authorization (Required) string Bearer {token}

Path Parameters
id (Required) integer The ID of the record
status (Required) string Any of ['complete', 'incomplete']