API Quickstart

An overview for developers of how to use the Togetherly API

Updated over a week ago

Quickstart

The Togetherly API provides a RESTful interface that provides secure programmatic access to the Togetherly platform, allowing you to integrate with your CRM or other services.

For your convenience we provide an automatically generated API documentation and test harness created with Swagger, accessible at: https://api.meetupcall.com/swagger.

API Overview

The base URL of the API is api.meetupcall.com, and provides the following endpoints:

Contacts endpoint

The contacts endpoint is used to list, create and update contacts.

  • GET "/api/v1/contacts": Retrieve a list of all contacts.

  • POST "/api/v1/contacts": Create a new contact.

  • GET "/api/v1/contacts/{contact_id}": Retrieve a specific contact.

  • POST "/api/v1/contacts/{contact_id}": Update a specific contact.

  • DELETE "/api/v1/contacts/{contact_id}": Delete a specific contact.

Matches endpoint

The matches endpoint is used to list, create and update befriending matches.

  • GET "/api/v1/matches": Retrieve a list of all matches.

  • POST "/api/v1/matches": Create a new match.

  • GET "/api/v1/matches/{match_id}": Retrieve a specific match.

  • DELETE "/api/v1/matches/{match_id}": Delete a specific match.

Sessions endpoint

The session endpoint is used to list, create and update individual group sessions.

  • GET "/api/v1/sessions": Retrieve a list of all scheduled sessions.

  • POST "/api/v1/sessions": Create a new session.

  • GET "/api/v1/sessions/{session_id}": Retrieve a specific scheduled session.

  • POST "/api/v1/sessions/{session_id}": Update a specific scheduled session.

  • DELETE "/api/v1/sessions/{session_id}": Delete a specific scheduled session.

Series endpoint

The series endpoint is used to list, create and update recurring group sessions.

  • POST "/api/v1/series": Create a new series of scheduled sessions.

  • GET "/api/v1/series/{series_id}": Retrieve a specific series of scheduled sessions.

  • POST "/api/v1/series/{series_id}": Update a specific series of scheduled sessions.

  • DELETE "/api/v1/series/{series_id}": Delete a specific series of scheduled sessions.

Activity endpoint

The activity endpoint is used to retrieve usage data.

  • GET "/api/v1/activity": Retrieve an activity report, with optional filters such as page number, start and end dates, session type, and contact ID.

Did this answer your question?