API Documentation

Authentication

1. Create a Lome Account: If you haven't already, sign up for a Lome account on our website. Note that you'll need a paid Customize account to take advantage of the API.

2. Get your Account ID and Secret: You'll want to go to your Settings > API page for the connection details.

3. Pass Authentication Headers with Each Request: For each request you make to the API - be sure to pass the following headers:

   "X-ACCOUNT-ID": [Your Account ID]

   "X-API-SECRET": [Your API Secret]

Base URL

For all requests, the base URL is:

https://grow.withlome.com/api

New Responses

GET /v1/webhook/new-response/recent

Lists all responses from the last 24 hours on your sign up forms.

Response

Here is the sample data that gets output from this request:

   {
      id: '8b4ab68d-57e3-4868-9874-47ee6e30cfcf',
      type: 'new_response',
      event_id: 'b6fe82da-b9f2-4287-bd00-b10e8e6191ca',
      event_title: 'Parent Teacher Conferences',
      event_link:
        'https://grow.withlome.com/a/b6fe82da-b9f2-4287-bd00-b10e8e6191ca',
      community: 'Martha Lake PTA',
      contact_name: 'Jane Doe',
      contact_email: 'janedoe@gmail.com',
      contact_phone: '1231231234',
      response_formatted: 'Apr 16 - 4:00pm-4:20pm',
      response_item: '4:00pm-4:20pm',
      response_date: '2025-04-16',
      response_start_time: '2025-04-16 16:00:00',
      response_end_time: '2025-04-16 16:20:00',
      response_group: '',
      response_number: 1,
      response_message: 'Mom of Johnny and Janie',
      response_custom_fields: {},
      created_at: '2024-09-06 12:20:00',
      updated_at: '2024-09-07 12:20:00',
    }

Community Responses

GET /v1/new-community-responses/recent?board_id={id}

Lists all responses from the past 24 hours based on events belonging to a specific Community.

Response

Here is the sample data that gets output from this request:

   {
      id: '8b4ab68d-57e3-4868-9874-47ee6e30cfcf',
      type: 'new_response',
      event_id: 'b6fe82da-b9f2-4287-bd00-b10e8e6191ca',
      event_title: 'Parent Teacher Conferences',
      event_link:
        'https://grow.withlome.com/a/b6fe82da-b9f2-4287-bd00-b10e8e6191ca',
      community: 'Martha Lake PTA',
      contact_name: 'Jane Doe',
      contact_email: 'janedoe@gmail.com',
      contact_phone: '1231231234',
      response_formatted: 'Apr 16 - 4:00pm-4:20pm',
      response_item: '4:00pm-4:20pm',
      response_date: '2025-04-16',
      response_start_time: '2025-04-16 16:00:00',
      response_end_time: '2025-04-16 16:20:00',
      response_group: '',
      response_number: 1,
      response_message: 'Mom of Johnny and Janie',
      response_custom_fields: {},
      created_at: '2024-09-06 12:20:00',
      updated_at: '2024-09-07 12:20:00',
    }

Communities List

GET /v1/communities

Lists all Communities where you are a Host or Co-Host.

Response

Here is the sample data that gets output from this request:

   {
      id: '8b4ab68d-57e3-4868-9874-47ee6e30cfcf',
      name: 'Martha Lake PTA',
      image: 'https://res.cloudinary.com/lome/image/upload/r_max/v1681334269/boards/fc485bc6-fa79-4259-b701-ba6f8cd53d06.png',
      color: '#179b2d',
      slug: 'martha-lake-pta',
      created_at: '2024-09-06 12:20:00',
    }

Create Contact

POST /v1/contacts

Create a new contact in your Lome Address Book

Request

There is a very simple data structure to create a Contact in Lome:

   {
      name: 'Jane Doe',
      email: 'janedoe@gmail.com',
      phone: '1231231234',
      source: 'api',
    }

Note that EITHER email or phone is required, you don't need both.

Response

Here is the sample data that gets output from this request:

   {
      id: '8b4ab68d-57e3-4868-9874-47ee6e30cfcf',
      name: 'Jane Doe',
      email: 'janedoe@gmail.com',
      phone: '1231231234',
      source: 'api',
      home_id: '8b4ab68d-57e3-4868-9874-47ee6e30cfcf',
      member_id: null,
      source_id: null,
      createdAt: '2025-01-01 14:00:00',
      updatedAt: '2025-01-01 14:00:00',
    }