List outgoing communications | Calendly

import { CalendlyClient } from "calendly";
async function main() {
    const client = new CalendlyClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.outgoingCommunications.listOutgoingCommunications({
        maxCreatedAt: new Date("2020-01-02T12:30:00Z"),
        minCreatedAt: new Date("2020-01-02T12:30:00Z"),
        organization: "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
    });
}
main();

{
  "collection": [
    {
      "body": "Your scheduled event is coming up.",
      "created_at": "2023-09-24T11:12:13.145Z",
      "event_type_uri": "https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA",
      "event_uri": "https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA",
      "from": "+14042916667",
      "scheduling_url": "https://calendly.com/event/name",
      "sender_email": "user@example.com",
      "sender_uri": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
      "sent_at": "2023-09-24T11:12:13.145Z",
      "subject": "",
      "to": "+14047549876",
      "type": "sms"
    }
  ],
  "pagination": {
    "count": 20,
    "next_page": "https://api.calendly.com/event_types?count=1&page_token=sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi",
    "previous_page": "https://api.calendly.com/event_types?count=1&page_token=VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H",
    "next_page_token": "sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi",
    "previous_page_token": "VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H"
  },
  "total_count": 1
}

This endpoint requires an Enterprise subscription.

Required scopes

outgoing_communications:read

Returns a list of outgoing SMS and email communications.

<Info> > This endpoint requires an <strong>Enterprise</strong> subscription. </Info> <Info title="Required scopes"> > `outgoing_communications:read` </Info> Returns a list of outgoing SMS and email communications.

Authentication

AuthorizationBearer

OAuth 2.0

AuthorizationBearer

Personal Access Token

Query parameters

organizationstringRequiredformat: "uri"

Return outgoing communications from the organization associated with this URI

countintegerOptional1-100Defaults to 20

The number of records to return

min_created_atstringOptionalformat: "date-time"

Include outgoing communications that were created after this time (sample time format: “2020-01-02T03:04:05.678Z”). This time should use the UTC timezone

max_created_atstringOptionalformat: "date-time"

Include outgoing communications that were created prior to this time (sample time format: “2020-01-02T03:04:05.678Z”). This time should use the UTC timezone

page_tokenstringOptional

The token to pass to get the next portion of the collection

Response

collectionlist of objects

The communications matching the criteria

paginationobject

total_countinteger>=0

Total number of records based on search criteria

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error