List Contacts

GET

/api/v1/contacts

• API de Produção

List contacts with pagination and filters.

Authorizations

• HTTPBearer

Parameters

Query Parameters

page

Page

integer

default: 1 >= 1

per_page

Per Page

integer

default: 20 >= 1 <= 100

search

Any of:

string

string

null

null

company_id

Any of:

integer

integer

null

null

tags

Any of:

string

string

null

null

is_active

Any of:

boolean

boolean

null

null

owner_id

Any of:

integer

integer

null

null

Header Parameters

x-tenant-id

Any of:

integer

integer

null

null

Responses

200

Successful Response

ContactListResponse

Schema for paginated contact list.

object

total

required

Total

integer

page

required

Page

integer

per_page

required

Per Page

integer

contacts

required

Contacts

Array<object>

ContactResponse

Schema for contact response.

object

full_name

required

Full Name

string

email

Any of:

string

string format: email

null

null

phone

Any of:

string

string

null

null

mobile

Any of:

string

string

null

null

job_title

Any of:

string

string

null

null

company_id

Any of:

integer

integer

null

null

address_line1

Any of:

string

string

null

null

address_line2

Any of:

string

string

null

null

city

Any of:

string

string

null

null

state

Any of:

string

string

null

null

postal_code

Any of:

string

string

null

null

country

Any of:

string

string

null

null

linkedin_url

Any of:

string

string

null

null

twitter_handle

Any of:

string

string

null

null

avatar_url

Any of:

string

string

null

null

tags

Any of:

string

string

null

null

source

Any of:

string

string

null

null

notes

Any of:

string

string

null

null

owner_id

Any of:

integer

integer

null

null

id

required

Id

integer

is_active

required

Is Active

boolean

last_contact_date

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

company_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