{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "{{ config(\"app.url\") }}" } ], "info": { "name": "HackGreenville API Documentation", "_postman_id": "02f8e2c2-2ed0-4974-80ae-71c644ff7e03", "description": "Documentation for the HackGreenville API. This API provides access to data stored in the HackGreenville database, such as events, organizations and more.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Endpoints", "description": "", "item": [ { "name": "Events API v0", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v0\/events", "query": [ { "key": "start_date", "value": "2026-01-01", "description": "The start date for events filtering (inclusive). Must be a valid date in the format Y-m-d. Must be a date before or equal to end_date.", "disabled": false }, { "key": "end_date", "value": "2100-12-31", "description": "The end date for events filtering (inclusive). Must be a valid date. Must be a valid date in the format Y-m-d. Must be a date after or equal to start_date.", "disabled": false }, { "key": "tags", "value": "", "description": "Filter events by organization tag ID.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v0\/events?start_date=2026-01-01&end_date=2100-12-31&tags=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This API provides access to event data stored in the HackGreenville database.\n\nPlease see the [Event API docs](https:\/\/github.com\/hackgvl\/hackgreenville-com\/blob\/develop\/EVENTS_API.md) for more information about the event API.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "[{\"event_name\":\"Eius et animi quos velit et.\",\"group_name\":\"Mrs. Justina Gaylord tech group!!!\",\"group_url\":\"quis\",\"url\":\"https:\\\/\\\/kunde.net\\\/est-quaerat-enim-accusantium-alias-magnam.html\",\"time\":\"2025-01-01T17:00:00.000000Z\",\"tags\":\"\",\"status\":\"past\",\"rsvp_count\":28,\"description\":\"Aut ex quo iure eos explicabo accusamus. Et qui ipsa itaque autem mollitia.\",\"uuid\":\"3f5d74c8-7495-3f45-bd67-0e0ddb6401b8\",\"data_as_of\":\"2026-01-01T12:00:00.000000Z\",\"service_id\":\"3\",\"service\":\"eventbrite\",\"venue\":{\"name\":\"placeat rerum ad in quo\",\"address\":\"39134 Heidenreich Shoal Apt. 942\\nReubenland, WY 88137-3873\",\"city\":\"Ladariushaven\",\"state\":\"MT\",\"zip\":\"30525-7075\",\"country\":\"EH\",\"lat\":\"24.605096\",\"lon\":\"153.784749\"},\"created_at\":\"2025-01-01T17:00:00.000000Z\",\"is_paid\":null}]", "name": "" } ] }, { "name": "Organizations API v0", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v0\/orgs", "query": [ { "key": "tags", "value": "", "description": "Filter organizations by organization tag ID.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v0\/orgs?tags=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This API provides access to organization data stored in the HackGreenville database.\n\nPlease see the [Organization API docs](https:\/\/github.com\/hackgvl\/hackgreenville-com\/blob\/develop\/ORGS_API.md) for more information about the organization API.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "[{\"title\":\"sunt\",\"path\":\"https:\\\/\\\/gaylord.com\\\/modi-deserunt-aut-ab-provident-perspiciatis.html\",\"changed\":\"2025-01-01T17:00:00.000000Z\",\"field_city\":\"Lyricberg\",\"field_event_service\":null,\"field_events_api_key\":null,\"field_focus_area\":\"adipisci\",\"field_homepage\":\"fugiat\",\"field_event_calendar_homepage\":\"http:\\\/\\\/hauck.com\\\/\",\"field_primary_contact_person\":\"quidem\",\"field_org_status\":\"active\",\"field_organization_type\":\"nostrum\",\"field_year_established\":2025,\"field_org_tags\":\"\",\"uuid\":123}]", "name": "" } ] }, { "name": "Events API v1", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/events", "query": [ { "key": "per_page", "value": "50", "description": "The number of items to show per page. Must be at least 1. Must not be greater than 100.", "disabled": false }, { "key": "page", "value": "1", "description": "The current page of items to display. Must be at least 1.", "disabled": false }, { "key": "start_date", "value": "2026-01-01", "description": "The start date for events filtering (inclusive). Future event data may be limited. Please see the [Event API docs](https:\/\/github.com\/hackgvl\/hackgreenville-com\/blob\/develop\/EVENTS_API.md) for information about event data limitations. Must be a valid date in the format Y-m-d. Must be a date before or equal to end_date.", "disabled": false }, { "key": "end_date", "value": "2100-12-31", "description": "The end date for events filtering (inclusive). Future event data may be limited. Please see the [Event API docs](https:\/\/github.com\/hackgvl\/hackgreenville-com\/blob\/develop\/EVENTS_API.md) for information about event data limitations. Must be a valid date in the format Y-m-d. Must be a date after or equal to start_date.", "disabled": false }, { "key": "tags[0]", "value": "16", "description": "The id of an existing record in the tags table.", "disabled": false }, { "key": "name", "value": "", "description": "Filter events by event name (the \"event_name\" property). Must not be greater than 255 characters.", "disabled": true }, { "key": "org_name", "value": "", "description": "The name of the organization associated with the event (the \"group_name\" property). Must not be greater than 255 characters.", "disabled": true }, { "key": "service", "value": "", "description": "The service that imported the event (meetup_graphql, eventbrite, etc.). Must not be greater than 255 characters.", "disabled": true }, { "key": "min_rsvp", "value": "", "description": "Must be at least 0.", "disabled": true }, { "key": "max_rsvp", "value": "", "description": "Must be at least 0.", "disabled": true }, { "key": "venue_city", "value": "", "description": "Must not be greater than 255 characters.", "disabled": true }, { "key": "venue_state", "value": "", "description": "Must be 2 characters.", "disabled": true }, { "key": "is_paid", "value": "", "description": "Filter events that require payment (null means we currently cannot determine if event is paid).", "disabled": true }, { "key": "sort_by", "value": "event_name", "description": "", "disabled": false }, { "key": "sort_direction", "value": "asc", "description": "", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/events?per_page=50&page=1&start_date=2026-01-01&end_date=2100-12-31&tags[0]=16&name=&org_name=&service=&min_rsvp=&max_rsvp=&venue_city=&venue_state=&is_paid=&sort_by=event_name&sort_direction=asc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This API provides access to event data stored in the HackGreenville database.\n\n* Please see the [Event API docs](https:\/\/github.com\/hackgvl\/hackgreenville-com\/blob\/develop\/EVENTS_API.md) for more information about the event API.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"3f5d74c8-7495-3f45-bd67-0e0ddb6401b8\",\"name\":\"Eius et animi quos velit et.\",\"description\":\"Aut ex quo iure eos explicabo accusamus. Et qui ipsa itaque autem mollitia.\",\"url\":\"https:\\\/\\\/kunde.net\\\/est-quaerat-enim-accusantium-alias-magnam.html\",\"starts_at\":\"2025-01-01T17:00:00.000000Z\",\"ends_at\":\"2025-01-01T19:00:00.000000Z\",\"rsvp_count\":28,\"status\":\"past\",\"is_paid\":null,\"organization\":{\"id\":123,\"name\":\"Mrs. Justina Gaylord tech group!!!\",\"url\":\"quis\",\"tags\":[]},\"venue\":{\"name\":\"placeat rerum ad in quo\",\"address\":\"39134 Heidenreich Shoal Apt. 942\\nReubenland, WY 88137-3873\",\"city\":\"Ladariushaven\",\"state\":{\"code\":\"MT\",\"name\":\"MT\"},\"zipcode\":\"30525-7075\",\"country\":\"EH\",\"location\":{\"latitude\":\"24.605096\",\"longitude\":\"153.784749\"}},\"service\":{\"name\":\"eventbrite\",\"id\":\"3\"},\"created_at\":\"2025-01-01T17:00:00.000000Z\",\"updated_at\":\"2025-01-01T17:00:00.000000Z\"}]}", "name": "" } ] }, { "name": "Organizations API v1", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organizations", "query": [ { "key": "per_page", "value": "50", "description": "The number of items to show per page. Must be at least 1. Must not be greater than 100.", "disabled": false }, { "key": "page", "value": "1", "description": "The current page of items to display. Must be at least 1.", "disabled": false }, { "key": "tags[]", "value": "", "description": "Filter organizations by tag ID. The id of an existing record in the tags table.", "disabled": true }, { "key": "title", "value": "", "description": "Must not be greater than 255 characters.", "disabled": true }, { "key": "city", "value": "", "description": "Must not be greater than 255 characters.", "disabled": true }, { "key": "focus_area", "value": "", "description": "The organization category (Entrpreneurship, Security, etc.). Must not be greater than 255 characters.", "disabled": true }, { "key": "organization_type", "value": "", "description": "The organization type (Meetup Groups, Code Schools, etc.). Must not be greater than 255 characters.", "disabled": true }, { "key": "status", "value": "", "description": "The organization status (active, inactive, etc.). Must not be greater than 255 characters.", "disabled": true }, { "key": "established_from", "value": "", "description": "The year the organization was established. Must be at least 1900. Must not be greater than current year.", "disabled": true }, { "key": "established_to", "value": "", "description": "The year the organization was dissolved. Must be at least 1900. Must not be greater than current year.", "disabled": true }, { "key": "sort_by", "value": "title", "description": "", "disabled": false }, { "key": "sort_direction", "value": "asc", "description": "", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/organizations?per_page=50&page=1&tags[]=&title=&city=&focus_area=&organization_type=&status=&established_from=&established_to=&sort_by=title&sort_direction=asc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This API provides access to organization data stored in the HackGreenville database.\n\n* Please see the [Organization API docs](https:\/\/github.com\/hackgvl\/hackgreenville-com\/blob\/develop\/ORGS_API.md) for more information about the organization API.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":123,\"title\":\"sunt\",\"path\":\"https:\\\/\\\/gaylord.com\\\/modi-deserunt-aut-ab-provident-perspiciatis.html\",\"city\":\"Lyricberg\",\"service\":null,\"service_api_key\":null,\"focus_area\":\"adipisci\",\"website_url\":\"fugiat\",\"event_calendar_url\":\"http:\\\/\\\/hauck.com\\\/\",\"primary_contact\":\"quidem\",\"status\":\"active\",\"organization_type\":\"nostrum\",\"established_year\":2025,\"tags\":[],\"created_at\":\"2025-01-01T17:00:00.000000Z\",\"updated_at\":\"2025-01-01T17:00:00.000000Z\"}]}", "name": "" } ] } ] } ], "auth": { "type": "noauth" } }