Developer Center

The HelpOut API is available to all HelpOut users to access their data programmatically.

API End Point

The following is the base URL for the HelpOut API. All endpoints will be prefixed with this URL.

Endpoint URL
https://helpout.us/api/v1
Authentication

You'll need to authenticate your requests to access any of the endpoints in the HelpOut API. In this guide, we'll look at how authentication works.

With API Key authentication, the X-API-Key HTTP header must be included in the request. You can access your API key from the HelpOut API page: https://helpout.us/users/api.

Example with an API KEY
curl --header "X-API-KEY: 123" https://helpout.us/api/v1/ping
Endpoint: Ping
get
https://helpout.us/api/v1/ping

This endpoint is used to check if the API is up and running. The user's email address is returned.

Request
curl https://helpout.us/api/v1/ping
Response
{
  "email": "user@example.com"
}
Endpoint: Events
get
https://helpout.us/api/v1/events

This endpoint is used to return events created in the authenticated account.

Request
curl https://helpout.us/api/v1/events
Response
[
  {
    "id": "walnut-grove-science-fair",
    "title": "Walnut Grove Science Fair",
    "event_at": "2026-04-02T01:00:00Z",
    "description": "Please join us ...",
    "event_type": "rsvp",
    "location": "Walnut Grove Elementary School"
  },
  ...
]
Endpoint: Responses
get
https://helpout.us/api/v1/events/:event_id/responses

This endpoint is used to return event responses for the specified event in the authenticated account.

Request
curl https://helpout.us/api/v1/events/walnut-grove-science-fair/responses
Response
[
  {
    "id": 72541498,
    "name": "Liz Grace",
    "email": "liz@example.com",
    "message": "Thank you!",
    "quantity": 1,
    "rsvp": "yes",
    "updated_at": "2025-06-01T01:35:00Z",
    "created_at": "2025-06-01T01:35:00Z"
  },
  {
    "id": 149489294,
    "name": "Liz Grace",
    "email": "liz@example.com",
    "message": "Thank you!",
    "processing_fee": "1.00",
    "amount": "15.00",
    "updated_at": "2025-06-01T01:35:00Z",
    "created_at": "2025-06-01T01:35:00Z"
  },
    "id": 492549406,
    "name": "Liz Grace",
    "email": "liz@futurefund.test",
    "message": "Thank you!",
    "quantity": 1,
    "slots": [
      {
        "name": "Teacher Conference (30 min)",
        "start_date": "2025-09-24T13:00:00-07:00",
        "end_date": "2025-09-24T13:30:00-07:00"
      },
      {
        "name": "Front Desk",
        "start_date": "2025-09-26T13:00:00-07:00",
        "end_date": "2025-09-26T13:30:00-07:00"
      }
    ],
    "updated_at": "2025-06-01T01:35:00Z",
    "created_at": "2025-06-01T01:35:00Z"
  },
  ...
]