List Contacts

GET

/public/v1/contacts

curl --request GET \
  --url 'https://api.aymaragents.com/public/v1/contacts?offset=0&limit=50' \
  --header 'X-API-Key: <X-API-Key>'

• Producción

List the tenant’s live contacts (SPEC_API_PUBLICA.md §2.2) – same filter/pagination semantics as the internal GET /customers.

---

Permiso necesario: tenant:contacts.read

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

search

Any of:

string

string

null

null

listId

Any of:

string

string format: uuid

null

null

offset

Offset

integer

0

limit

Limit

integer

default: 50 >= 1 <= 200

Responses

200

Successful Response

Media typeapplication/json

PublicContactsResponse

GET /public/v1/contacts response envelope – same shape as the internal CustomersResponse (PAGIN-1).

object

items

required

Items

Array<object>

PublicContactOut

A single contact, curated subset of the internal CustomerOut.

Drops signingEmail (INT-PANDADOC-1 internal-integration concern, meaningless to a third party reading/writing contacts generically).

object

id

required

Id

string

fullName

Any of:

string

string

null

null

phone

Any of:

string

string

null

null

email

Any of:

string

string

null

null

country

Any of:

string

string

null

null

phoneVerifiedAt

Any of:

string

string

null

null

emailVerifiedAt

Any of:

string

string

null

null

marketingOptOut

required

Marketingoptout

boolean

marketingOptOutAt

Any of:

string

string

null

null

origin

required

Origin

string

createdAt

required

Createdat

string

total

required

Total

integer

nextCursor

Any of:

string

string

null

null

pagination

required

OffsetPaginationMeta

12-api-contract.md §3.2 offset/limit pagination metadata, verbatim shape.

object

page

required

Page

integer

pageSize

required

Pagesize

integer

totalItems

required

Totalitems

integer

totalPages

required

Totalpages

integer

hasNext

required

Hasnext

boolean

hasPrev

required

Hasprev

boolean

Example^generated

{
  "items": [
    {
      "id": "example",
      "fullName": "example",
      "phone": "example",
      "email": "example",
      "country": "example",
      "phoneVerifiedAt": "example",
      "emailVerifiedAt": "example",
      "marketingOptOut": true,
      "marketingOptOutAt": "example",
      "origin": "example",
      "createdAt": "example"
    }
  ],
  "total": 1,
  "nextCursor": "example",
  "pagination": {
    "page": 1,
    "pageSize": 1,
    "totalItems": 1,
    "totalPages": 1,
    "hasNext": true,
    "hasPrev": true
  }
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}