List Activities

GET

/api/v1/activities

• API de Produção

List activities with pagination and filters.

Authorizations

• HTTPBearer

Parameters

Query Parameters

page

Page

integer

default: 1 >= 1

per_page

Per Page

integer

default: 20 >= 1 <= 100

type

Any of:

ActivityType

ActivityType

Activity type enum.

string

Allowed values: note task call meeting email whatsapp

null

null

status

Any of:

ActivityStatus

ActivityStatus

Activity status enum.

string

Allowed values: pending in_progress completed cancelled

null

null

contact_id

Any of:

integer

integer

null

null

company_id

Any of:

integer

integer

null

null

user_id

Any of:

integer

integer

null

null

sort_by

Any of:

string

string

null

null

Field to sort by

sort_order

Any of:

string

string

null

null

Sort order: asc or desc

Header Parameters

x-tenant-id

Any of:

integer

integer

null

null

Responses

200

Successful Response

ActivityListResponse

Schema for paginated activity list.

object

total

required

Total

integer

page

required

Page

integer

per_page

required

Per Page

integer

activities

required

Activities

Array<object>

ActivityResponse

Schema for activity response.

object

type

required

ActivityType

Activity type enum.

string

Allowed values: note task call meeting email whatsapp

title

required

Title

string

description

Any of:

string

string

null

null

contact_id

Any of:

integer

integer

null

null

company_id

Any of:

integer

integer

null

null

user_id

required

User Id

integer

due_date

Any of:

string

string format: date-time

null

null

duration_minutes

Any of:

integer

integer

null

null

outcome

Any of:

string

string

null

null

id

required

Id

integer

status

required

ActivityStatus

Activity status enum.

string

Allowed values: pending in_progress completed cancelled

completed_at

Any of:

string

string format: date-time

null

null

created_at

required

Created At

string format: date-time

updated_at

Any of:

string

string format: date-time

null

null

contact_name

Any of:

string

string

null

null

company_name

Any of:

string

string

null

null

user_name

Any of:

string

string

null

null

custom_fields

Any of:

object

object

null

null

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string