Skip to main content
GET
/
contacts
/
events
Get contact events for a specific month and year
curl --request GET \
  --url https://www.postable.com/api/v1/contacts/events \
  --header 'Authorization: Bearer <token>'
[
  {
    "title": "January 1st",
    "text": "John Smith's Birthday",
    "event_date": "2024-01-01T00:00:00+00:00",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
year
integer
required
Example:

2024

​
month
integer
required
Required range: 1 <= x <= 12
Example:

1

Response

200 - application/json

List of contact events

​
title
string
required

Formatted date of the event

Example:

"January 1st"

​
text
string
required

Description of the event (e.g. "John's Birthday")

Example:

"John Smith's Birthday"

​
event_date
string<date-time>
required

ISO8601 formatted date-time string

Example:

"2024-01-01T00:00:00+00:00"

​
uuid
string<uuid>
required

UUID of the contact associated with the event

Example:

"123e4567-e89b-12d3-a456-426614174000"