List entities (filter by kind: lead / account / contact)

GET

/api/dash/{orgId}/entities

curl --request GET \
  --url 'https://api.medivy.id/api/dash/example/entities?page=1&size=20&kind=lead&lastActivity=all&sort=createdAt&order=asc' \
  --header 'x-api-key: <x-api-key>'

• Production

Authorizations

• apiKey

Parameters

Path Parameters

orgId

required

string

Your organization ID. The API key must belong to this organization.

Query Parameters

page

number | null

default: 1

size

number | null

default: 20

kind

string

Allowed values: lead account contact

typeId

string

typeIds

string

search

string

isActive

string

lastActivity

string

Allowed values: all today yesterday this_week this_month past_3_months past_6_months this_year

lastActivityFrom

string

lastActivityTo

string

createdFrom

string

createdTo

string

groupIds

string

ownerIds

string

sort

string

Allowed values: createdAt lastActivityAt

order

string

Allowed values: asc desc

favorite

string

Responses

200

OK

Media typeapplication/json

Example ^generated

example

401

Missing, invalid, disabled or expired API key.

Media typeapplication/json

object

ok

message

string

Example

{
  "ok": false
}

403

The key belongs to another organization, the request came from an IP outside the key’s allowlist, or the key’s user lacks the permission.

Media typeapplication/json

object

ok

message

string

Example

{
  "ok": false
}

429

Too many requests from this organization.

Media typeapplication/json

object

ok

message

string

Example

{
  "ok": false
}