List Contacts

GET

/platform/v1/contacts

curl --request GET \
  --url https://example.com/platform/v1/contacts

Parameters

Query Parameters

channel_id

Any of:

integer

integer

null

null

search

Any of:

string

string

null

null

after

Any of:

string

string

null

null

before

Any of:

string

string

null

null

limit

Any of:

integer

integer

null

null

Responses

200

Successful Response

Media type application/json

PlatformContactPage

object

data

required

Data

Array<object>

PlatformContactResponse

object

business_scoped_user_id

Any of:

string

string

null

null

contact_metadata

Contact Metadata

object

key

additional properties

any

created_at

required

Created At

string format: date-time

display_name

Any of:

string

string

null

null

first_seen_at

required

First Seen At

string format: date-time

id

required

Id

integer

ig_id

Any of:

string

string

null

null

last_seen_at

required

Last Seen At

string format: date-time

phone

Any of:

string

string

null

null

platform_channel_id

required

Platform Channel Id

integer

profile_name

Any of:

string

string

null

null

username

Any of:

string

string

null

null

wa_id

Any of:

string

string

null

null

next_cursor

Any of:

string

string

null

null

prev_cursor

Any of:

string

string

null

null

Example

{
  "data": [
    {
      "contact_metadata": {}
    }
  ]
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example ^generated

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