Get all contacts

GET 
/v1/contacts

Get all contacts

The get_contacts endpoint retrieves a paginated list of contacts filtered by various parameters such as wallet ID, sorting criteria, and search terms. It supports filtering by creation dates and returns contacts sorted according to the specified field and order.

Request

Query Parameters

wallet_id string

Filter by wallet id

sort_by string

Sort by field

order_by string

Order by field

page int32

Page number

page_size int32

Page size

search string

Search by name or email

end_date date-time

End date

start_date date-time

Start date

Responses

200

Contacts

application/json

Schema

Schema

• Array [
createdAt date-timerequired
email stringnullable
id uuidrequired
name stringrequired
walletId uuidrequired
• ]

Example (from schema)

[
  {
    "createdAt": "2024-09-25T19:42:12.426Z",
    "email": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "walletId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
]

400

Invalid page or page_size value

text/plain

Schema

Schema

string

500

Internal server error

text/plain

Schema

Schema

string

Loading...