API

Introduction

The Goodera API is designed to seamlessly integrate with your applications, enabling you to leverage our vast database of opportunities and events. Whether you are looking to fetch detailed information about specific opportunities, list all available opportunities, manage event details, or handle registrations, our RESTful API provides a robust and intuitive way to connect with the Goodera platform. With the Goodera API, you have access to:

Opportunities: Search and retrieve detailed information about volunteer opportunities and initiatives.
Events: Manage event details, from creation to querying specific events.
Registrations: Facilitate user registrations for events with ease.

Our API is structured around REST, which is easy to use and compatible with a wide variety of programming languages and tools. Responses are returned in JSON format, and standard HTTP response codes are used to indicate API errors.

Opportunities

Base API URL:

https://developer-api.goodera.com/opportunities

Get opportunity

API URL:

https://developer-api.goodera.com/opportunities/{id}

Fetches one opportunity from the identifier sent in path params.

Field	Type	Description	Required	Example
eventId	string	The identifier of the opportunity which has to retrieved	true	“65f96d1e1d38620012d38261”

curl --location --request GET 'https://developer-api.goodera.com/opportunities/610cc05de85e70001106f7d9' \
--header 'x-api-key: <YOUR-API-KEY>'

200

Request Successful

401

Unauthorized

403

Unauthenticated

500

Internal Server Error

{
    "rows": [
        {
            "id": "610cc05de85e70001106f7d9",
            "name": "Test Before Handover - 8th Aug",
            "eventLabel": "TEAM_BASED",
            "description": "Event description - This is a test event created on 8th August 2021",
            "richTextDescription": "<p>Event description - This is a test event created on 8th August 2021</p>",
            "eventLocationType": "VIRTUAL",
            "organization": "6103c43fb023d40011fbf06b",
            "partner": "618a60f52ba1cb00114b8ac8",
            "expectedImpact": "Why volunteer - This is a test event created on 8th August 2021",
            "preRequisites": "Prerequisites - This is a test event created on 8th August 2021",
            "minVolunteers": 50,
            "maxVolunteers": 100,
            "duration": [
                60
            ],
            "countries": [
                "AF",
                "IN"
            ],
            "languages": [],
            "beneficiaries": [
                "ADUL"
            ],
            "causes": [
                "SJH",
                "ANIM",
                "CAPB",
                "CHY",
                "COM"
            ],
            "type": "DIGITAL_CARDS",
            "deck": "https://www.google.com/maps",
            "isPaid": false
        },
        {
            "id": "611e0de8e771a4001191e0a6",
            "name": "Test Before Handover - 19th August",
            "eventLabel": "TEAM_BASED",
            "description": "This is a test event created on 19th August 2021 ( Thursday @1.30 PM ).",
            "eventLocationType": "VIRTUAL",
            "organization": "6103c43fb023d40011fbf06b",
            "partner": "60f70bbe26f5c40011f2d011",
            "expectedImpact": "",
            "preRequisites": "This is a test event created on 19th August 2021 ( Thursday @1.30 PM ).\nThis event should reflect on Champions page",
            "minVolunteers": 100,
            "maxVolunteers": 1000,
            "duration": 120,
            "countries": [
                "AI",
                "AG"
            ],
            "languages": [],
            "beneficiaries": [],
            "causes": [],
            "type": "PM_LETTER",
            "deck": null,
            "isPaid": false
        },
        {
            "id": "611e309bd4de0d00113bfcf1",
            "name": "create ",
            "eventLabel": "TEAM_BASED",
            "description": "qazwsx",
            "eventLocationType": "VIRTUAL",
            "organization": "6103c43fb023d40011fbf06b",
            "partner": "60d890e9337f310011e71c68",
            "expectedImpact": "wedf",
            "preRequisites": "wsxcv",
            "minVolunteers": 7,
            "maxVolunteers": 500,
            "duration": [
                60
            ],
            "countries": [
                "AD",
                "US"
            ],
            "languages": [],
            "beneficiaries": [
                "ADOL"
            ],
            "causes": [
                "SJH"
            ],
            "type": "AUDIOBOOK",
            "deck": null,
            "isPaid": false
        },
        {
            "id": "613ed2a46256690011a9949f",
            "name": "Test Before Handover - 13th September",
            "eventLabel": "TEAM_BASED",
            "description": "Test event created on 13th September 2021. Edited for testing on 4th October.",
            "eventLocationType": "VIRTUAL",
            "organization": "6103c43fb023d40011fbf06b",
            "partner": "60f70bbe26f5c40011f2d011",
            "expectedImpact": "",
            "preRequisites": "",
            "minVolunteers": 50,
            "maxVolunteers": 100,
            "duration": 60,
            "countries": [
                "GLOBAL",
                "US"
            ],
            "languages": [],
            "beneficiaries": [],
            "causes": [],
            "type": "LEARNING_AID",
            "deck": "https://api.p3fy.com/api/containers/goodera-vv/download/rvHrwhy9uZq6eoplyFxiqFO5RPga0GlDreoXSaC4uVJBcJQqtyV72HbYRPaeLVSm_1633341258747sampleeventdeck.pdf?redirect=false",
            "isPaid": false
        },
        {
            "id": "617803965a2e9a00114afb10",
            "name": "Test Before Handover - 26th October 2021",
            "eventLabel": "TEAM_BASED",
            "description": "This is a test event created on 26th October 2021 @7.00 PM",
            "richTextDescription": "<p>This is a test event created on 26th October 2021 @7.00 PM</p>",
            "eventLocationType": "VIRTUAL",
            "organization": "6103c43fb023d40011fbf06b",
            "partner": "60f70bbe26f5c40011f2d011",
            "expectedImpact": "Test",
            "preRequisites": "Test",
            "minVolunteers": 25,
            "maxVolunteers": 50,
            "duration": [
                60
            ],
            "countries": [
                "US"
            ],
            "languages": [],
            "beneficiaries": [
                "ADOL"
            ],
            "causes": [
                "SJH"
            ],
            "type": "COV_EFLASHCARD",
            "deck": "https://api.p3fy.com/api/containers/goodera-vv/download/hEHhmZ1B309dtk2iLiuvFhWdRS4Xw5wvhsabcQYPafUoKJA5vy5Q48lA8nmG7DPi_1635255182286sampleeventdeck.pdf?redirect=false",
            "isPaid": false
        },
        {
            "id": "61b87c93e596780011a4ae81",
            "name": "Test Before Handover - 14 December",
            "eventLabel": "TEAM_BASED",
            "description": "Test",
            "eventLocationType": "VIRTUAL",
            "organization": "6103c43fb023d40011fbf06b",
            "partner": "618a60f52ba1cb00114b8ac8",
            "expectedImpact": "",
            "preRequisites": "test test",
            "minVolunteers": 26,
            "maxVolunteers": 50,
            "duration": [
                60
            ],
            "countries": [
                "US"
            ],
            "languages": [],
            "beneficiaries": [],
            "causes": [],
            "type": "AUDIOBOOK",
            "deck": null,
            "isPaid": false
        },
        {
            "id": "61a9f806c607b500117e434b",
            "name": "Test Before Handover - 3rd December",
            "eventLabel": "TEAM_BASED",
            "description": "Test event",
            "eventLocationType": "VIRTUAL",
            "organization": "6103c43fb023d40011fbf06b",
            "partner": "618a60f52ba1cb00114b8ac8",
            "expectedImpact": "",
            "preRequisites": "",
            "minVolunteers": 25,
            "maxVolunteers": 50,
            "duration": 60,
            "countries": [
                "US"
            ],
            "languages": [],
            "beneficiaries": [],
            "causes": [],
            "type": "AUDIOBOOK",
            "deck": null,
            "isPaid": false
        },
        {
            "id": "61b9f76b0f984f0011ede61b",
            "name": "Record audiobooks to spread cheer to children battling cancer",
            "eventLabel": "TEAM_BASED",
            "description": "This Christmas, show your support by recording audiobooks or fables, or stories for children battling cancer. ",
            "eventLocationType": "VIRTUAL",
            "organization": "6103c43fb023d40011fbf06b",
            "partner": "6172afa270bcd000118fe875",
            "expectedImpact": "Your voice will help provide emotional support to these children who would benefit from feeling a sense of solidarity and comfort. ",
            "preRequisites": "Please ensure you have a mobile phone/any other device with an audio recording app installed and a quiet place to record prior to the activity.",
            "minVolunteers": 7,
            "maxVolunteers": 500,
            "duration": 30,
            "countries": [
                "GLOBAL"
            ],
            "languages": [],
            "beneficiaries": [
                "ADOL",
                "CHIL"
            ],
            "causes": [
                "CHY",
                "HLTH"
            ],
            "type": "HOLIDAY",
            "deck": null,
            "isPaid": false
        },
        {
            "id": "61c3425fca27bb00114e350a",
            "name": "Test Before Handover - 22nd December 2021",
            "eventLabel": "TEAM_BASED",
            "description": "This is a test event",
            "eventLocationType": "VIRTUAL",
            "organization": "6103c43fb023d40011fbf06b",
            "partner": "618a60f52ba1cb00114b8ac8",
            "expectedImpact": "",
            "preRequisites": "",
            "minVolunteers": 25,
            "maxVolunteers": 50,
            "duration": [
                60
            ],
            "countries": [
                "US"
            ],
            "languages": [],
            "beneficiaries": [
                "ADOL",
                "ADUL"
            ],
            "causes": [
                "SJH",
                "ANIM"
            ],
            "type": "AUDIOBOOK",
            "deck": null,
            "isPaid": false
        },
        {
            "id": "621319461caf8e001133c143",
            "name": "Test Before Handover - 21st Feb 2022",
            "eventLabel": "TEAM_BASED",
            "description": "Test Event for 21st Feb 2022",
            "eventLocationType": "VIRTUAL",
            "organization": "6103c43fb023d40011fbf06b",
            "partner": "618a60f52ba1cb00114b8ac8",
            "expectedImpact": "",
            "preRequisites": "",
            "minVolunteers": 25,
            "maxVolunteers": 100,
            "duration": [
                60
            ],
            "countries": [
                "US"
            ],
            "languages": [],
            "beneficiaries": [],
            "causes": [],
            "type": "AUDIOBOOK",
            "deck": null,
            "isPaid": false
        }
    ],
    "total": 117,
    "page": 1,
    "pageSize": 10,
    "totalPages": 12
}

List opportunities

API URL:

https://developer-api.goodera.com/opportunities/

Fetches a paginated list of opportunities.

Field	Type	Description	Required	Example
countryCode	string	The country of opportunity in which the opportunity is available	false	“US”
durations	number[]	The duration in which the opportunity can be conducted	false	[60,90]
eventLocationType	enum(’VIRTUAL’, ‘IN_PERSON’)	The event format of the opportunity	false	‘VIRTUAL]
pageSize	number	Number of rows to retrieve at once	false	10
page	number	The country of opportunity in which the opportunity is available	false	“US”

curl --location --request GET 'https://developer-api.goodera.com/opportunities?pageSize=10' \
--header 'x-api-key: <YOUR-API-KEY>'

200

Request Successful

401

Unauthorized

403

Unauthenticated

500

Internal Server Error

{
    "rows": [
        {
            "id": "610cc05de85e70001106f7d9",
            "name": "Test Before Handover - 8th Aug",
            "eventLabel": "TEAM_BASED",
            "description": "Event description - This is a test event created on 8th August 2021",
            "richTextDescription": "<p>Event description - This is a test event created on 8th August 2021</p>",
            "eventLocationType": "VIRTUAL",
            "organization": "6103c43fb023d40011fbf06b",
            "partner": "618a60f52ba1cb00114b8ac8",
            "expectedImpact": "Why volunteer - This is a test event created on 8th August 2021",
            "preRequisites": "Prerequisites - This is a test event created on 8th August 2021",
            "minVolunteers": 50,
            "maxVolunteers": 100,
            "duration": [
                60
            ],
            "countries": [
                "AF",
                "IN"
            ],
            "languages": [],
            "beneficiaries": [
                "ADUL"
            ],
            "causes": [
                "SJH",
                "ANIM",
                "CAPB",
                "CHY",
                "COM"
            ],
            "type": "DIGITAL_CARDS",
            "deck": "https://www.google.com/maps",
            "isPaid": false
        },
        {
            "id": "611e0de8e771a4001191e0a6",
            "name": "Test Before Handover - 19th August",
            "eventLabel": "TEAM_BASED",
            "description": "This is a test event created on 19th August 2021 ( Thursday @1.30 PM ).",
            "eventLocationType": "VIRTUAL",
            "organization": "6103c43fb023d40011fbf06b",
            "partner": "60f70bbe26f5c40011f2d011",
            "expectedImpact": "",
            "preRequisites": "This is a test event created on 19th August 2021 ( Thursday @1.30 PM ).\nThis event should reflect on Champions page",
            "minVolunteers": 100,
            "maxVolunteers": 1000,
            "duration": 120,
            "countries": [
                "AI",
                "AG"
            ],
            "languages": [],
            "beneficiaries": [],
            "causes": [],
            "type": "PM_LETTER",
            "deck": null,
            "isPaid": false
        },
        {
            "id": "611e309bd4de0d00113bfcf1",
            "name": "create ",
            "eventLabel": "TEAM_BASED",
            "description": "qazwsx",
            "eventLocationType": "VIRTUAL",
            "organization": "6103c43fb023d40011fbf06b",
            "partner": "60d890e9337f310011e71c68",
            "expectedImpact": "wedf",
            "preRequisites": "wsxcv",
            "minVolunteers": 7,
            "maxVolunteers": 500,
            "duration": [
                60
            ],
            "countries": [
                "AD",
                "US"
            ],
            "languages": [],
            "beneficiaries": [
                "ADOL"
            ],
            "causes": [
                "SJH"
            ],
            "type": "AUDIOBOOK",
            "deck": null,
            "isPaid": false
        },
        {
            "id": "613ed2a46256690011a9949f",
            "name": "Test Before Handover - 13th September",
            "eventLabel": "TEAM_BASED",
            "description": "Test event created on 13th September 2021. Edited for testing on 4th October.",
            "eventLocationType": "VIRTUAL",
            "organization": "6103c43fb023d40011fbf06b",
            "partner": "60f70bbe26f5c40011f2d011",
            "expectedImpact": "",
            "preRequisites": "",
            "minVolunteers": 50,
            "maxVolunteers": 100,
            "duration": 60,
            "countries": [
                "GLOBAL",
                "US"
            ],
            "languages": [],
            "beneficiaries": [],
            "causes": [],
            "type": "LEARNING_AID",
            "deck": "https://api.p3fy.com/api/containers/goodera-vv/download/rvHrwhy9uZq6eoplyFxiqFO5RPga0GlDreoXSaC4uVJBcJQqtyV72HbYRPaeLVSm_1633341258747sampleeventdeck.pdf?redirect=false",
            "isPaid": false
        },
        {
            "id": "617803965a2e9a00114afb10",
            "name": "Test Before Handover - 26th October 2021",
            "eventLabel": "TEAM_BASED",
            "description": "This is a test event created on 26th October 2021 @7.00 PM",
            "richTextDescription": "<p>This is a test event created on 26th October 2021 @7.00 PM</p>",
            "eventLocationType": "VIRTUAL",
            "organization": "6103c43fb023d40011fbf06b",
            "partner": "60f70bbe26f5c40011f2d011",
            "expectedImpact": "Test",
            "preRequisites": "Test",
            "minVolunteers": 25,
            "maxVolunteers": 50,
            "duration": [
                60
            ],
            "countries": [
                "US"
            ],
            "languages": [],
            "beneficiaries": [
                "ADOL"
            ],
            "causes": [
                "SJH"
            ],
            "type": "COV_EFLASHCARD",
            "deck": "https://api.p3fy.com/api/containers/goodera-vv/download/hEHhmZ1B309dtk2iLiuvFhWdRS4Xw5wvhsabcQYPafUoKJA5vy5Q48lA8nmG7DPi_1635255182286sampleeventdeck.pdf?redirect=false",
            "isPaid": false
        },
        {
            "id": "61b87c93e596780011a4ae81",
            "name": "Test Before Handover - 14 December",
            "eventLabel": "TEAM_BASED",
            "description": "Test",
            "eventLocationType": "VIRTUAL",
            "organization": "6103c43fb023d40011fbf06b",
            "partner": "618a60f52ba1cb00114b8ac8",
            "expectedImpact": "",
            "preRequisites": "test test",
            "minVolunteers": 26,
            "maxVolunteers": 50,
            "duration": [
                60
            ],
            "countries": [
                "US"
            ],
            "languages": [],
            "beneficiaries": [],
            "causes": [],
            "type": "AUDIOBOOK",
            "deck": null,
            "isPaid": false
        },
        {
            "id": "61a9f806c607b500117e434b",
            "name": "Test Before Handover - 3rd December",
            "eventLabel": "TEAM_BASED",
            "description": "Test event",
            "eventLocationType": "VIRTUAL",
            "organization": "6103c43fb023d40011fbf06b",
            "partner": "618a60f52ba1cb00114b8ac8",
            "expectedImpact": "",
            "preRequisites": "",
            "minVolunteers": 25,
            "maxVolunteers": 50,
            "duration": 60,
            "countries": [
                "US"
            ],
            "languages": [],
            "beneficiaries": [],
            "causes": [],
            "type": "AUDIOBOOK",
            "deck": null,
            "isPaid": false
        },
        {
            "id": "61b9f76b0f984f0011ede61b",
            "name": "Record audiobooks to spread cheer to children battling cancer",
            "eventLabel": "TEAM_BASED",
            "description": "This Christmas, show your support by recording audiobooks or fables, or stories for children battling cancer. ",
            "eventLocationType": "VIRTUAL",
            "organization": "6103c43fb023d40011fbf06b",
            "partner": "6172afa270bcd000118fe875",
            "expectedImpact": "Your voice will help provide emotional support to these children who would benefit from feeling a sense of solidarity and comfort. ",
            "preRequisites": "Please ensure you have a mobile phone/any other device with an audio recording app installed and a quiet place to record prior to the activity.",
            "minVolunteers": 7,
            "maxVolunteers": 500,
            "duration": 30,
            "countries": [
                "GLOBAL"
            ],
            "languages": [],
            "beneficiaries": [
                "ADOL",
                "CHIL"
            ],
            "causes": [
                "CHY",
                "HLTH"
            ],
            "type": "HOLIDAY",
            "deck": null,
            "isPaid": false
        },
        {
            "id": "61c3425fca27bb00114e350a",
            "name": "Test Before Handover - 22nd December 2021",
            "eventLabel": "TEAM_BASED",
            "description": "This is a test event",
            "eventLocationType": "VIRTUAL",
            "organization": "6103c43fb023d40011fbf06b",
            "partner": "618a60f52ba1cb00114b8ac8",
            "expectedImpact": "",
            "preRequisites": "",
            "minVolunteers": 25,
            "maxVolunteers": 50,
            "duration": [
                60
            ],
            "countries": [
                "US"
            ],
            "languages": [],
            "beneficiaries": [
                "ADOL",
                "ADUL"
            ],
            "causes": [
                "SJH",
                "ANIM"
            ],
            "type": "AUDIOBOOK",
            "deck": null,
            "isPaid": false
        },
        {
            "id": "621319461caf8e001133c143",
            "name": "Test Before Handover - 21st Feb 2022",
            "eventLabel": "TEAM_BASED",
            "description": "Test Event for 21st Feb 2022",
            "eventLocationType": "VIRTUAL",
            "organization": "6103c43fb023d40011fbf06b",
            "partner": "618a60f52ba1cb00114b8ac8",
            "expectedImpact": "",
            "preRequisites": "",
            "minVolunteers": 25,
            "maxVolunteers": 100,
            "duration": [
                60
            ],
            "countries": [
                "US"
            ],
            "languages": [],
            "beneficiaries": [],
            "causes": [],
            "type": "AUDIOBOOK",
            "deck": null,
            "isPaid": false
        }
    ],
    "total": 117,
    "page": 1,
    "pageSize": 10,
    "totalPages": 12
}

Events

Create event

API URL:

POST https://developer-api.goodera.com/events

Creates a volunteering event for given opportunity

Field	Type	Description	Required	Example
opportunityId	string	The identifier of the opportunity for which the event has to be created	true	“61c3425fca27bb00114e350a”
startTimeStamp	string	ISO formatted timestamp of the start time of the event	true	“2024-03-08T18:49:37.116Z”
endTimeStamp	string	ISO formatted timestamp of the end time of the event	true	“2024-03-08T19:49:37.116Z”
timezone	string	A string from the list of timezones.	true	“Asia/Kolkata”
country	string	Country in which event has to be created	true	“IN”
language	string	Language in which event has to be created	true	“ENG”
email	string	Email of the user booking the event	true	karan.saklani@goodera.com
name	string	Name of the user booking the event	true	“Karan”
expectedVolunteerCount	number	Expected number of volunteers attending the event	true	1
eventLocation	`"city": "string", required "country": "string", optional "country_short_name": "string", required "displayAddress": "string", required "geometry": { "lat": number, required "lng": number, required }, "url": string, required "name": string, required "place_id": string, optional`	Map location of the event	true when opportunity.type == in_person	`{ "city": "Mumbai", "country": "India", "country_short_name": "IN", "displayAddress": "Mumbai, Maharashtra, India", "geometry": { "lat": 19.0759837, "lng": 72.8776559 }, "url": "https://maps.google.com/?q=Mumbai,+Maharashtra,+India&ftid=0x3be7c6306644edc1:0x5da4ed8f8d648c69", "name": "Mumbai", "place_id": "ChIJwe1EZjDG5zsRaYxkjY_tpF0" }`
addressLine	string	The venue details of the event location	false, visible when opportunity.type == in_person	"Hustle Hub Tech Park H208 36/5 3rd Floor Somasundarapalya 27th Main Road"

curl --location --request POST 'https://developer-api.goodera.com/events' \
--header 'x-api-key: <YOUR-API-KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
 "opportunityId": "639990db13a1a90012b7b79d",
 "startTimeStamp": "2024-06-08T18:49:37.116Z",
 "endTimeStamp": "2024-06-08T19:49:37.116Z",
 "timezone": "Asia/Kolkata",
 "country": [
 "IN"
 ],
 "language": "ENG",
 "email": "karan.saklani@goodera.com",
 "name": "Karan Saklani",
 "eventLocation": {
 "city": "Mumbai",
 "country": "India",
 "country_short_name": "IN",
 "displayAddress": "Mumbai, Maharashtra, India",
 "geometry": {
 "lat": 19.0759837,
 "lng": 72.8776559
 },
 "url": "https://maps.google.com/?q=Mumbai,+Maharashtra,+India&ftid=0x3be7c6306644edc1:0x5da4ed8f8d648c69",
 "name": "Mumbai",
 "place_id": "ChIJwe1EZjDG5zsRaYxkjY_tpF0"
 },
 "addressLine": " ",
 "expectedVolunteerCount": 1
}'

200

Request Successful

401

Unauthorized

403

Unauthenticated

500

Internal Server Error

{
"id": "65f96c9232be9d001205ec9a"
}

Fetch event

API URL:

GET https://developer-api.goodera.com/events/{eventId}

Get status of the event

Field	Type	Description	Required	Example
eventId	string	The event for which data is requested	false	“65f96c9232be9d001205ec9a”

curl --location --request GET 'https://developer-api.goodera.com/events/65f994a0dd1c11001241eec3' \
--header 'x-api-key: <YOUR-API-KEY>'

200

Request Successful

401

Unauthorized

403

Unauthenticated

500

Internal Server Error

{
    "id": "65f994a0dd1c11001241eec3",
    "startTimeStamp": "2024-03-08T18:49:37.116Z",
    "endTimeStamp": "2024-03-08T19:49:37.116Z",
    "opportunity": {
        "_id": "610cc05de85e70001106f7d9",
        "name": "Test Before Handover - 8th Aug",
        "description": "Event description - This is a test event created on 8th August 2021",
        "richTextDescription": "<p>Event description - This is a test event created on 8th August 2021</p>",
        "eventLabel": "TEAM_BASED",
        "bu": "GLOBAL",
        "type": "DIGITAL_CARDS",
        "itinerary": [
            {
                "_id": "610cc05de85e70001106f7da",
                "duration": 30,
                "title": "Welcome",
                "description": "Itinerary - This is a test event created on 8th August 2021."
            },
            {
                "_id": "62824af058197b00113f4bc4",
                "title": "first 10 min",
                "duration": 10,
                "description": "desc 10 min"
            },
            {
                "_id": "62824af058197b00113f4bc5",
                "title": "next half an hour",
                "duration": 30,
                "description": "half an hour"
            },
            {
                "_id": "62824af058197b00113f4bc6",
                "title": "last 15 min",
                "duration": 15,
                "description": "Event"
            },
            {
                "_id": "62824af058197b00113f4bc7",
                "title": "Whole event",
                "duration": 60,
                "description": "event "
            }
        ],
        "bannerUrl": "https://api.p3fy.com/api/containers/goodera-vv/download/ADdBjgbKQltVMfpxssuMgOrnAzB43PU3KCQbesKvlSxCMbBxqThXoXxyQDmVLah3_1628225516759cropped.jpg?redirect=false",
        "organization": {
            "_id": "6103c43fb023d40011fbf06b",
            "name": "Goodera Test 2",
            "logo": "https://api.p3fy.com/api/containers/goodera-vv/download/eWyYWk9e7RVVhTYH7qI26qybAa7cA811QG6ND80s9KkPm86Kx23PdBxfiAg8720n_1648566616955cropped.jpg?redirect=false",
            "championsConfig": {
                "allowedConfirmItems": [
                    1,
                    2,
                    3
                ],
                "organizeNonProfit": "https://goodera.typeform.com/to/Z4L11SFG?utm_source=prodtest",
                "csmCalendly": "https://calendly.com/shubham-chhabra-94/30min",
                "csmName": "Shubham Chhabra - PROD",
                "csmEmail": "shubham.chhabra@goodera.com",
                "csmPicture": "https://images-prod.goodera.com/csmPicture/1680084392215_cropped.jpeg",
                "csmUpdated": false,
                "logo": "https://api.p3fy.com/api/containers/nextgen-objects/download/uHvQiPyLnWp5tYtpHsUUR9qrmaiQmcaBbGXhWn6rDQSOF6XI6XFd8zJsONgurN45_IBM.png",
                "showGooderaLogo": false,
                "showClientLogo": true,
                "videoLink": “”,
                "pdfLink": "",
                "calendarTAT": 8,
                "inPersonCalendarTAT": 8,
                "showAddGuests": true,
                "showICCheckbox": false,
                "showICButton": true,
                "showNewChampions": false,
                "active": true,
                "showVolunteeringPage": false,
                "hideAllCards": false,
                "defaultEventLocationType": "IN_PERSON",
                "disableNewInPersonFlow": true,
                "allowEmailDomainBlacklisting": true,
                "eventBookingBlacklistedEmailDomains": [
                    "gmail",
                    "yahoo",
                    "hotmail",
                    "aol",
                    "msn",
                    "live",
                    "ymail",
                    "outlook"
                ],
                "showChatBaseBot": false,
                "disableTalkToExpertGlobally": false,
                "showMcdCard": false,
                "showGptOnDetailsPage": false,
                "showGptOnPostBookingPage": true,
                "showGptOnDashboardPage": false,
                "_id": "624317eadf0a6500110f984e",
                "banners": [
                    {
                        "disable": false,
                        "_id": "639852a0bd76b80012d4d39b",
                        "bannerType": "BOOK_EVENT_THREE_STEPS"
                    },
                    {
                        "disable": false,
                        "_id": "639852a0bd76b80012d4d39c",
                        "bannerType": "TALK_TO_EXPERT"
                    },
                    {
                        "disable": true,
                        "_id": "63bd25de14efe900128b4391",
                        "linkUrl": "https://volunteer-client.goodera.com/",
                        "desktopImageUrl": {
                            "en": {
                                "cloudinaryUrl": "https://res.cloudinary.com/goodera-vv-assets/image/upload/v1673340284/vv-prod/BannerImage/desktop/en/1673340283140_cropped.webp",
                                "bannerUrl": "https://images-prod.goodera.com/BannerImage/desktop/en/1673340283140_cropped.jpeg"
                            },
                            "fr": {
                                "cloudinaryUrl": "https://res.cloudinary.com/goodera-vv-assets/image/upload/v1673340284/vv-prod/BannerImage/desktop/en/1673340283140_cropped.webp",
                                "bannerUrl": "https://images-prod.goodera.com/BannerImage/desktop/en/1673340283140_cropped.jpeg"
                            },
                            "es": {
                                "cloudinaryUrl": "https://res.cloudinary.com/goodera-vv-assets/image/upload/v1673340284/vv-prod/BannerImage/desktop/en/1673340283140_cropped.webp",
                                "bannerUrl": "https://images-prod.goodera.com/BannerImage/desktop/en/1673340283140_cropped.jpeg"
                            },
                            "pt": {
                                "cloudinaryUrl": "https://res.cloudinary.com/goodera-vv-assets/image/upload/v1673340284/vv-prod/BannerImage/desktop/en/1673340283140_cropped.webp",
                                "bannerUrl": "https://images-prod.goodera.com/BannerImage/desktop/en/1673340283140_cropped.jpeg"
                            },
                            "zh-CN": {
                                "cloudinaryUrl": "https://res.cloudinary.com/goodera-vv-assets/image/upload/v1673340284/vv-prod/BannerImage/desktop/en/1673340283140_cropped.webp",
                                "bannerUrl": "https://images-prod.goodera.com/BannerImage/desktop/en/1673340283140_cropped.jpeg"
                            }
                        },
                        "mobileImageUrl": {
                            "en": {
                                "cloudinaryUrl": "https://res.cloudinary.com/goodera-vv-assets/image/upload/v1673340370/vv-prod/BannerImage/mobileen/1673340368330_cropped.webp",
                                "bannerUrl": "https://images-prod.goodera.com/BannerImage/mobileen/1673340368330_cropped.jpeg"
                            },
                            "fr": {
                                "cloudinaryUrl": "https://res.cloudinary.com/goodera-vv-assets/image/upload/v1673340370/vv-prod/BannerImage/mobileen/1673340368330_cropped.webp",
                                "bannerUrl": "https://images-prod.goodera.com/BannerImage/mobileen/1673340368330_cropped.jpeg"
                            },
                            "es": {
                                "cloudinaryUrl": "https://res.cloudinary.com/goodera-vv-assets/image/upload/v1673340370/vv-prod/BannerImage/mobileen/1673340368330_cropped.webp",
                                "bannerUrl": "https://images-prod.goodera.com/BannerImage/mobileen/1673340368330_cropped.jpeg"
                            },
                            "pt": {
                                "cloudinaryUrl": "https://res.cloudinary.com/goodera-vv-assets/image/upload/v1673340370/vv-prod/BannerImage/mobileen/1673340368330_cropped.webp",
                                "bannerUrl": "https://images-prod.goodera.com/BannerImage/mobileen/1673340368330_cropped.jpeg"
                            },
                            "zh-CN": {
                                "cloudinaryUrl": "https://res.cloudinary.com/goodera-vv-assets/image/upload/v1673340370/vv-prod/BannerImage/mobileen/1673340368330_cropped.webp",
                                "bannerUrl": "https://images-prod.goodera.com/BannerImage/mobileen/1673340368330_cropped.jpeg"
                            }
                        },
                        "bannerType": "IMAGE"
                    }
                ],
                "testimonials": [
                    {
                        "_id": "653b7e6746feb300121a501d",
                        "embedLink": "https://www.linkedin.com/embed/feed/update/urn:li:share:6988147117127008257",
                        "postLink": "https://google.com/"
                    },
                    {
                        "_id": "653b7e6746feb300121a501e",
                        "embedLink": "https://www.linkedin.com/embed/feed/update/urn:li:share:6996532280135434241",
                        "postLink": "https://www.linkedin.com/posts/christascott_volunteer-giveback-lifeatriverbed-activity-6996532281041391616-lw8w?utm_source=share&utm_medium=member_desktop"
                    },
                    {
                        "_id": "653b7e6746feb300121a501f",
                        "embedLink": "https://www.linkedin.com/embed/feed/update/urn:li:share:6995404319739019264",
                        "postLink": "https://google.com/"
                    },
                    {
                        "_id": "653b7e6746feb300121a5020",
                        "embedLink": "https://www.linkedin.com/embed/feed/update/urn:li:ugcPost:7003245052688777216",
                        "postLink": "https://www.linkedin.com/posts/hackerrank_coding-and-variables-activity-7003245053296930816-DbBw?utm_source=share&utm_medium=member_desktop"
                    }
                ],
                "slug": "prodtest",
                "webhookUrl": "https://hooks.zapier.com/hooks/catch/8231831/b5czbsb/",
                "eventTagSortOrder": {
                    "LEARNING_AID": 0,
                    "WHM": 1,
                    "AUDIOBOOK": 2,
                    "PM_LETTER": 3,
                    "DIGITAL_CARDS": 4,
                    "APPLE_HOLIDAY": 5,
                    "WORKSHOP": 6,
                    "BI": 7,
                    "COV_VIDEO": 8,
                    "HOLIDAY": 9,
                    "COV_ECOMIC": 10,
                    "EPOSTER": 11,
                    "QUIZ": 12,
                    "COV_EFLASHCARD": 13,
                    "UKRAINE": 14
                },
                "lpBannerConfig": {
                    "isEnabled": false,
                    "bannerOrder": [
                        "IMAGE",
                        "TALK_TO_EXPERT"
                    ],
                    "_id": "636e151210185300111564a6",
                    "linkUrl": "",
                    "desktopImageUrl": "https://images-prod.goodera.com/BannerImage/desktop/1669134312074_cropped.jpeg",
                    "mobileImageUrl": "https://images-prod.goodera.com/BannerImage/mobile/1669135006667_cropped.jpeg"
                },
                "inPersonWebhookUrl": "",
                "zohoAnalyticsUrl": "https://analytics.zoho.com/open-view/2606433000000162221/79eac558a2d1f0a319953befe272c876",
                "allowedLastBookingDate": null
            },
            "benevityName": [
                "prodtestaug18",
                "prodtest",
                "prodbenevity",
                "newdom",
                "testdom",
                "testproduct"
            ],
            "webhookUrl": "https://script.google.com/macros/s/AKfycbz_iX2QCHBT0otmwUx8FFjT-d1DiAxo2aATFQKTQ6PKu1vZbb3UtwM2YK0d1p7dYtJugw/exec",
            "autoAllocateMeetingForBookings": true,
            "sendThankYouAsPdf": true,
            "thankyouEmailConfig": {
                "ngoReferral": false,
                "socialShare": false,
                "mailerColor": "#001919",
                "feedbackOption": false,
                "showCustomURL": false,
                "feedbackLink": "https://survey.zohopublic.com/zs/0Jz0Ff",
                "showCustomText": false,
                "_id": "65ddb04bb368040012e9c264",
                "addedCustomText": "",
                "customText": "Submission Link",
                "customURL": "https://vvapp.goodera.com/event/submissions/65ae3f7876e88e00123f671d"
            },
            "eventExecutionConfig": {
                "disableAdjustedParticipantCount": true,
                "eventMaterialInReminderMail": [
                    "Template"
                ],
                "_id": "65645eb296267c001241060c",
                "vrpRequired": true,
                "reminderMailFrequency": "Reminder email frequency goes here",
                "submissionLinkPlatform": "Dropbox",
                "materialLinkPlatform": "Dropbox",
                "camerasToBeOn": true,
                "eventRecordingPossible": true,
                "timeTrackingPushRequired": true,
                "bookingPromotionAllowed": true,
                "goodfieAllowed": true,
                "hostJoiningTime": "20 mins before the start time",
                "clientProgramMaterialLink": "Client program material link goes here"
            },
            "meetingPlatform": "ZOOM",
            "showLogoOnChampionsPage": true,
            "showLogoInMailer": true,
            "thirdPartyIntegrator": "NONE",
            "disabled": false,
            "meetingRegistrationRequired": true,
            "deckFormat": "Deck format goes here",
            "countries": [],
            "instanceId": "Clients_5lSIyBY_ZI",
            "thirdPartyEventSyncPreference": "ALL",
            "showAttendanceScanner": true,
            "createdAt": "2021-07-30T09:19:59.371Z",
            "createdBy": "60d86ad9e742244abc282592",
            "updatedAt": "2024-02-27T09:50:03.969Z",
            "updatedBy": "60f5220e29ef1500116a6ec0",
            "active": true
        },
        "partner": "618a60f52ba1cb00114b8ac8",
        "countries": [
            "AF",
            "IN"
        ],
        "languages": [],
        "causes": [
            "SJH",
            "ANIM",
            "CAPB",
            "CHY",
            "COM"
        ],
        "beneficiaries": [
            "ADUL"
        ],
        "calendlyUrl": "",
        "championsEnabled": false,
        "disabled": false,
        "infiniteDuration": true,
        "expectedImpact": "Why volunteer - This is a test event created on 8th August 2021",
        "preRequisites": "Prerequisites - This is a test event created on 8th August 2021",
        "minVolunteers": 50,
        "maxVolunteers": 100,
        "duration": [
            60
        ],
        "deck": "https://www.google.com/maps",
        "triggerCalendarUpdate": false,
        "oppTags": [
            "62e21f2d54d6bd0011eee194"
        ],
        "eventLocationType": "VIRTUAL",
        "cloudinaryUrl": "https://res.cloudinary.com/goodera-vv-assets/image/upload/v1664435232/vv-prod/events/1664435231188_cropped.webp",
        "instanceId": "Event_SKUs_1_5nv0q_N0UJ",
        "eventCount": 53,
        "isPaid": false,
        "createdAt": "2021-08-06T04:53:49.210Z",
        "createdBy": "60d86ad9e742244abc282592",
        "updatedAt": "2024-03-19T13:35:30.192Z",
        "updatedBy": "61407cfaa1954d0011e03982",
        "active": true
    },
    "status": "ACTIVE",
    "name": "Test Before Handover - 8th Aug",
    "organizationId": "6103c43fb023d40011fbf06b",
    "partnerId": "618a60f52ba1cb00114b8ac8”,
    "eventLocation": {
		"city": "Mumbai",
		"country": "India",
		"country_short_name": "IN",
		"displayAddress": "Mumbai, Maharashtra, India",
		"geometry": {
			"lat": 19.0759837,
			"lng": 72.8776559
			},
		"url": "https://maps.google.com/?q=Mumbai,+Maharashtra,+India&ftid=0x3be7c6306644edc1:0x5da4ed8f8d648c69",
		"name": "Mumbai",
		"place_id": "ChIJwe1EZjDG5zsRaYxkjY_tpF0"
		},
    "addressLine": "Hustle Hub Tech Park H208 36/5 3rd Floor Somasundarapalya 27th Main Road,",
    "videoMeetingDetails": {
 	"mode": "MANUAL",
 	"meetingUrl": "",
 	"passcode": "",
 	"manualMeeting": null
 	}
    }
}

Registrations

Add registration

API URL:

POST https://developer-api.goodera.com/registrations

Used for creation of registrations for an event

Field	Type	Description	Required	Example
eventId	string	The event for which registration is added	true	“61c3425fca27bb00114e350a”
startTimeStamp	string	The email for registration to be created	true	“2024-03-08T18:49:37.116Z”

curl --location --request POST 'https://developer-api.goodera.com/registrations' \
--header 'x-api-key: <YOUR-API-KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "eventId": "65f96c9232be9d001205ec9a",
    "email":"karansaklani201@gmail.com"
}'

200

Request Successful

401

Unauthorized

403

Unauthenticated

500

Internal Server Error

{
    "_id": "65f96d1e1d38620012d38261",
    "event": "65f96c9232be9d001205ec9a",
    "organizationUser": "65f96d1eedbaa600127874a4",
    "zoomAttended": false,
    "thankYouEmailSent": false,
    "attendance": false,
    "createdAt": "2024-03-19T10:46:54.778Z",
    "updatedAt": "2024-03-19T10:46:54.778Z",
    "active": true
}

Delete registration

API URL:

DELETE https://developer-api.goodera.com/registrations/{registrationId}

Delete registration added for an event

Field	Type	Description	Required	Example
registrationId	string	The registrationId for which registration has to be removed	false	“65f96d1e1d38620012d38261”

curl --location --request DELETE 'https://developer-api.goodera.com/registrations/' \
--header 'x-api-key: <YOUR-API-KEY>'

200

Request Successful

401

Unauthorized

403

Unauthenticated

500

Internal Server Error

{ success: true }

Get registrations for an event

API URL:

GET https://developer-api.goodera.com/registrations/by_event/{eventId}

Get a list of registrations for an event.
Deleted registrations will be removed from the list

Field	Type	Description	Required	Example
eventId	string	The identifier of the event for which registrations have to be fetched	true	“65f96d1e1d38620012d38261”

curl --location --request GET 'https://developer-api.goodera.com/registrations/by_event/{id}' \
--header 'x-api-key: <YOUR-API-KEY>'

200

Request Successful

401

Unauthorized

403

Unauthenticated

500

Internal Server Error

[
    {
        "id": "65f97f6e7551f1001344d8ba",
        "email": "partnerships2@goodera.com",
        "attended": false,
        "createdAt": "2024-03-19T12:05:02.869Z",
        "updatedAt": "2024-03-19T12:05:02.869Z",
        "eventId": "65f97e5700c7700012ccc64c"
    },
    {
        "id": "65f97f6e7551f1001344d8bb",
        "email": "karan.saklani@goodera.com",
        "attended": false,
        "createdAt": "2024-03-19T12:05:02.869Z",
        "updatedAt": "2024-03-19T12:05:02.869Z",
        "eventId": "65f97e5700c7700012ccc64c"
    }
]

Tracking Time

Add participation

API URL:

POST https://developer-api.goodera.com/participation

Used for creation of participations for an event

Field	Type	Description	Required	Example
eventId	string	The event for which participation is added	true	“61c3425fca27bb00114e350a”
startTimeStamp	string	The email for participation to be created	true	“2024-03-08T18:49:37.116Z”

curl --location --request POST 'https://developer-api.goodera.com/participation' \
--header 'x-api-key: <YOUR-API-KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "eventId": "65f96c9232be9d001205ec9a",
    "email":"karansaklani201@gmail.com"
}'

200

Request Successful

401

Unauthorized

403

Unauthenticated

500

Internal Server Error

{
    "_id": "65f96d1e1d38620012d38261",
    "event": "65f96c9232be9d001205ec9a",
    "organizationUser": "65f96d1eedbaa600127874a4",
    "zoomAttended": true,
    "thankYouEmailSent": true,
    "attendance": true,
    "createdAt": "2024-03-19T10:46:54.778Z",
    "updatedAt": "2024-03-19T10:46:54.778Z",
    "active": true
}

Master data

Timezone

API URL:

GET https://developer-api.goodera.com/master-data/timezone

Unauthenticated

Country

API URL:

GET https://developer-api.goodera.com/master-data/country

Unauthenticated

Language

API URL:

GET https://developer-api.goodera.com/master-data/language

Unauthenticated