Static REST Documentation

Also available: dynamic REST documentation

This documentation explains the syntax of our API and provides examples on how to use it. If you don't have an API key, please see our API page for more information.

By using LGL's APIs, you represent that you have read and fully understand our API Terms of Use Agreement.

Authentication

Generate an API key

Administrators can generate API keys in their Little Green Light account by going to Settings > Integration settings, and then clicking on the LGL API link. If that link is not visible, please request access by writing to support@littlegreenlight.com, with details about how you plan to use the API and which LGL account you will use for development.

Using your API key

There are three ways you can pass your API key to the LGL API server. You will need to check with your HTTP or Client library for how to use each method. Examples use the 'curl' command line application.

HTTP Basic Authentication

HTTP Basic Authentication allows you to pass a username and password. In this case, set the username to the API key and leave the password blank.

Example:

curl -u [api_key]: "https://api.littlegreenlight.com/api/v1/constituents"

Use the "access_token" parameter

You can provide the API key in each call by using the "access_token" parameter.

Example:

curl "https://api.littlegreenlight.com/api/v1/constituents?access_token=[api_key]"

Use the "Bearer" HTTP authorization header

Example:

curl -H "Authorization: Bearer [api_key]" "https://api.littlegreenlight.com/api/v1/constituents"

AppealRequests Management

GET /api/v1/appeals/{appeal_id}/appeal_requests - Fetch Appeal Requests for Appeal

Lists all the appeal requests for an appeal.

Parameter Name Description Type Required? Parameter Type
appeal_id Appeal Id integer true path
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "constituent_id": 0,
      "constituent_name": "",
      "appeal_id": 0,
      "name": "",
      "raised": 0,
      "status": "",
      "ask_amount": 0,
      "assigned_to": 0,
      "custom_fields": [
        {
          "id": 0,
          "item_type": "",
          "name": "",
          "key": "",
          "facet_type": "",
          "ordinal": 0,
          "removable": true,
          "editable": true,
          "values": [
            {
              "category_id": 0,
              "name": "",
              "description": "",
              "short_code": "",
              "ordinal": 0,
              "removable": true,
              "can_change": true,
              "can_select": true
            }
          ]
        }
      ],
      "custom_attrs": [
        {
          "id": 0,
          "classification": "",
          "name": "",
          "key": "",
          "ordinal": 0,
          "value": ""
        }
      ],
      "created_at": "",
      "updated_at": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/appeals/2663/appeal_requests

Query:
limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 5,
  "total_items": 82,
  "limit": 5,
  "offset": 0,
  "next_item": 5,
  "next_link": "https://api.littlegreenlight.com/api/v1/appeals/2663/appeal_requests?limit=5&offset=5",
  "item_type": "appeal_request",
  "items": [
    {
      "id": 316126,
      "constituent_id": 959486,
      "constituent_name": "Archer's",
      "appeal_id": 2663,
      "name": "Appeal: Annual Appeal 2020 (2021-07-01)",
      "raised": 0.0,
      "status": "open",
      "ask_amount": 100.0,
      "assigned_to": 1047042,
      "custom_fields": [

      ],
      "custom_attrs": [

      ],
      "created_at": "2023-10-31T18:01:04Z",
      "updated_at": "2023-10-31T18:01:04Z"
    },
    {
      "id": 316127,
      "constituent_id": 959440,
      "constituent_name": "Avengers Mansion Headquarters of the Avengers",
      "appeal_id": 2663,
      "name": "Appeal: Annual Appeal 2020 (2021-07-01)",
      "raised": 0.0,
      "status": "open",
      "ask_amount": 100.0,
      "assigned_to": 1047042,
      "custom_fields": [

      ],
      "custom_attrs": [

      ],
      "created_at": "2023-10-31T18:01:04Z",
      "updated_at": "2023-10-31T18:01:04Z"
    },
    {
      "id": 316128,
      "constituent_id": 959453,
      "constituent_name": "Barone, Ray",
      "appeal_id": 2663,
      "name": "Appeal: Annual Appeal 2020 (2021-07-01)",
      "raised": 0.0,
      "status": "open",
      "ask_amount": 100.0,
      "assigned_to": 1047042,
      "custom_fields": [

      ],
      "custom_attrs": [

      ],
      "created_at": "2023-10-31T18:01:04Z",
      "updated_at": "2023-10-31T18:01:04Z"
    },
    {
      "id": 316129,
      "constituent_id": 959465,
      "constituent_name": "Baxter, Joseph",
      "appeal_id": 2663,
      "name": "Appeal: Annual Appeal 2020 (2021-07-01)",
      "raised": 0.0,
      "status": "open",
      "ask_amount": 100.0,
      "assigned_to": 1047042,
      "custom_fields": [

      ],
      "custom_attrs": [

      ],
      "created_at": "2023-10-31T18:01:04Z",
      "updated_at": "2023-10-31T18:01:04Z"
    },
    {
      "id": 316130,
      "constituent_id": 959474,
      "constituent_name": "Black, Frank",
      "appeal_id": 2663,
      "name": "Appeal: Annual Appeal 2020 (2021-07-01)",
      "raised": 0.0,
      "status": "open",
      "ask_amount": 100.0,
      "assigned_to": 1047042,
      "custom_fields": [

      ],
      "custom_attrs": [

      ],
      "created_at": "2023-10-31T18:01:04Z",
      "updated_at": "2023-10-31T18:01:04Z"
    }
  ]
}
                



POST /api/v1/appeals/{appeal_id}/appeal_requests - Create new Appeal Request

Add appeal request.

Parameter Name Description Type Required? Parameter Type
appeal_id Appeal Id integer true path
body Create Objects CreateBody true body

CreateBody

CreateBody {
constituent_id ( integer , required ): Constituent Id,
appeal_id ( integer , required ): Appeal Id,
ask_amount ( double , optional ): Donated,
status ( string , optional ): Status,
assigned_to ( integer , optional ): Assigned to team member id,
custom_fields ( array , optional , CustomFieldAggregatedUpdate ): Appeal request custom fields (Categories),
custom_attrs ( array , optional , CustomAttr_create ): Appeal request custom attrubutes
}
CustomFieldAggregatedUpdate {
id ( integer , optional ): Custom Field Id,
name ( string , required ): Name,
key ( string , optional ): Key,
remove_previous_values ( boolean , optional ): Remove previous field values,
values ( array , required , CustomValueAggregatedUpdate ): Values
}
CustomValueAggregatedUpdate {
id ( integer , required ): Value Id,
name ( string , required ): Name
}
CustomAttr_create {
id ( integer , optional ): Custom Field Id,
key ( string , optional ): Key,
value ( string , required ): Value
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "constituent_name": "",
  "appeal_id": 0,
  "name": "",
  "raised": 0,
  "status": "",
  "ask_amount": 0,
  "assigned_to": 0,
  "custom_fields": [
    {
      "id": 0,
      "item_type": "",
      "name": "",
      "key": "",
      "facet_type": "",
      "ordinal": 0,
      "removable": true,
      "editable": true,
      "values": [
        {
          "category_id": 0,
          "name": "",
          "description": "",
          "short_code": "",
          "ordinal": 0,
          "removable": true,
          "can_change": true,
          "can_select": true
        }
      ]
    }
  ],
  "custom_attrs": [
    {
      "id": 0,
      "classification": "",
      "name": "",
      "key": "",
      "ordinal": 0,
      "value": ""
    }
  ],
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/appeals/2663/appeal_requests

Body:
                  
{
  "constituent_id": "959480",
  "ask_amount": 100.0
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 316214,
  "constituent_id": 959480,
  "constituent_name": "Appleton, Larry",
  "appeal_id": 2663,
  "name": "Appeal: Annual Appeal 2020 (2021-07-01)",
  "raised": 0.0,
  "status": "open",
  "ask_amount": 100.0,
  "assigned_to": null,
  "custom_fields": [

  ],
  "custom_attrs": [

  ],
  "created_at": "2024-02-06T15:58:05Z",
  "updated_at": "2024-02-06T15:58:05Z"
}
                



GET /api/v1/appeal_requests/{id} - Show Appeal Request details

Show details for the appeal request.

Parameter Name Description Type Required? Parameter Type
id Appeal Request Id integer true path


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "constituent_name": "",
  "appeal_id": 0,
  "name": "",
  "raised": 0,
  "status": "",
  "ask_amount": 0,
  "assigned_to": 0,
  "custom_fields": [
    {
      "id": 0,
      "item_type": "",
      "name": "",
      "key": "",
      "facet_type": "",
      "ordinal": 0,
      "removable": true,
      "editable": true,
      "values": [
        {
          "category_id": 0,
          "name": "",
          "description": "",
          "short_code": "",
          "ordinal": 0,
          "removable": true,
          "can_change": true,
          "can_select": true
        }
      ]
    }
  ],
  "custom_attrs": [
    {
      "id": 0,
      "classification": "",
      "name": "",
      "key": "",
      "ordinal": 0,
      "value": ""
    }
  ],
  "created_at": "",
  "updated_at": ""
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/appeal_requests/316214

Response:
                  
{
  "api_version": "1.0",
  "id": 316214,
  "constituent_id": 959480,
  "constituent_name": "Appleton, Larry",
  "appeal_id": 2663,
  "name": "Appeal: Annual Appeal 2020 (2021-07-01)",
  "raised": 0.0,
  "status": "open",
  "ask_amount": 100.0,
  "assigned_to": null,
  "custom_fields": [

  ],
  "custom_attrs": [

  ],
  "created_at": "2024-02-06T15:58:05Z",
  "updated_at": "2024-02-06T15:58:05Z"
}
                



PATCH /api/v1/appeal_requests/{id} - Update Appeal Request

Update the appeal request.

Parameter Name Description Type Required? Parameter Type
id Appeal Request Id integer true path
body Update Objects UpdateBody true body

UpdateBody

UpdateBody {
constituent_id ( integer , required ): Constituent Id,
appeal_id ( integer , required ): Appeal Id,
ask_amount ( double , optional ): Donated,
status ( string , optional ): Status,
assigned_to ( integer , optional ): Assigned to team member id,
custom_fields ( array , optional , CustomFieldAggregatedUpdate ): Appeal request custom fields (Categories),
custom_attrs ( array , optional , CustomAttr_create ): Appeal request custom attrubutes
}
CustomFieldAggregatedUpdate {
id ( integer , optional ): Custom Field Id,
name ( string , required ): Name,
key ( string , optional ): Key,
remove_previous_values ( boolean , optional ): Remove previous field values,
values ( array , required , CustomValueAggregatedUpdate ): Values
}
CustomValueAggregatedUpdate {
id ( integer , required ): Value Id,
name ( string , required ): Name
}
CustomAttr_create {
id ( integer , optional ): Custom Field Id,
key ( string , optional ): Key,
value ( string , required ): Value
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "constituent_name": "",
  "appeal_id": 0,
  "name": "",
  "raised": 0,
  "status": "",
  "ask_amount": 0,
  "assigned_to": 0,
  "custom_fields": [
    {
      "id": 0,
      "item_type": "",
      "name": "",
      "key": "",
      "facet_type": "",
      "ordinal": 0,
      "removable": true,
      "editable": true,
      "values": [
        {
          "category_id": 0,
          "name": "",
          "description": "",
          "short_code": "",
          "ordinal": 0,
          "removable": true,
          "can_change": true,
          "can_select": true
        }
      ]
    }
  ],
  "custom_attrs": [
    {
      "id": 0,
      "classification": "",
      "name": "",
      "key": "",
      "ordinal": 0,
      "value": ""
    }
  ],
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/appeal_requests/316214

Body:
                  
{
  "ask_amount": "200"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 316214,
  "constituent_id": 959480,
  "constituent_name": "Appleton, Larry",
  "appeal_id": 2663,
  "name": "Appeal: Annual Appeal 2020 (2021-07-01)",
  "raised": 0.0,
  "status": "open",
  "ask_amount": 200.0,
  "assigned_to": null,
  "custom_fields": [

  ],
  "custom_attrs": [

  ],
  "created_at": "2024-02-06T15:58:05Z",
  "updated_at": "2024-02-06T15:58:06Z"
}
                



DELETE /api/v1/appeal_requests/{id} - Delete Appeal Request

Delete the appeal request.

Parameter Name Description Type Required? Parameter Type
id Appeal Request Id integer true path


Code Message Response
200 Ok
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/appeal_requests/316214

Response:
                  
{
  "api_version": "1.0",
  "result": "success"
}
                



POST /api/v1/constituents/{constituent_id}/appeal_requests - Create new Appeal Request for Constituent

Add appeal request to constituent.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
body Create Objects CreateBody_Const true body

CreateBody_Const

CreateBody_Const {
appeal_id ( integer , required ): Appeal Id,
ask_amount ( double , optional ): Donated,
status ( string , optional ): Status,
assigned_to ( integer , optional ): Assigned to team member id,
custom_fields ( array , optional , CustomFieldAggregatedUpdate ): Appeal request custom fields (Categories),
custom_attrs ( array , optional , CustomAttr_create ): Appeal request custom attrubutes
}
CustomFieldAggregatedUpdate {
id ( integer , optional ): Custom Field Id,
name ( string , required ): Name,
key ( string , optional ): Key,
remove_previous_values ( boolean , optional ): Remove previous field values,
values ( array , required , CustomValueAggregatedUpdate ): Values
}
CustomValueAggregatedUpdate {
id ( integer , required ): Value Id,
name ( string , required ): Name
}
CustomAttr_create {
id ( integer , optional ): Custom Field Id,
key ( string , optional ): Key,
value ( string , required ): Value
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "constituent_name": "",
  "appeal_id": 0,
  "name": "",
  "raised": 0,
  "status": "",
  "ask_amount": 0,
  "assigned_to": 0,
  "custom_fields": [
    {
      "id": 0,
      "item_type": "",
      "name": "",
      "key": "",
      "facet_type": "",
      "ordinal": 0,
      "removable": true,
      "editable": true,
      "values": [
        {
          "category_id": 0,
          "name": "",
          "description": "",
          "short_code": "",
          "ordinal": 0,
          "removable": true,
          "can_change": true,
          "can_select": true
        }
      ]
    }
  ],
  "custom_attrs": [
    {
      "id": 0,
      "classification": "",
      "name": "",
      "key": "",
      "ordinal": 0,
      "value": ""
    }
  ],
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity



GET /api/v1/constituents/{constituent_id}/appeal_requests - Fetch Appeal Requests for Constituent

Lists all the appeal requests for a constituent.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "constituent_id": 0,
      "constituent_name": "",
      "appeal_id": 0,
      "name": "",
      "raised": 0,
      "status": "",
      "ask_amount": 0,
      "assigned_to": 0,
      "custom_fields": [
        {
          "id": 0,
          "item_type": "",
          "name": "",
          "key": "",
          "facet_type": "",
          "ordinal": 0,
          "removable": true,
          "editable": true,
          "values": [
            {
              "category_id": 0,
              "name": "",
              "description": "",
              "short_code": "",
              "ordinal": 0,
              "removable": true,
              "can_change": true,
              "can_select": true
            }
          ]
        }
      ],
      "custom_attrs": [
        {
          "id": 0,
          "classification": "",
          "name": "",
          "key": "",
          "ordinal": 0,
          "value": ""
        }
      ],
      "created_at": "",
      "updated_at": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/appeal_requests

Query:
limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 5,
  "offset": 0,
  "item_type": "appeal_request",
  "items": [

  ]
}
                



Appeals Management

GET /api/v1/appeals - Fetch Appeals

Lists all the appeals.

Parameter Name Description Type Required? Parameter Type
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "name": "",
      "description": "",
      "date": "",
      "financial_goal": 0,
      "projected_amount": 0,
      "code": "",
      "is_active": true
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/appeals

Query:
limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 4,
  "total_items": 4,
  "limit": 5,
  "offset": 0,
  "item_type": "appeal",
  "items": [
    {
      "id": 2660,
      "name": "Board Mailing (sample)",
      "description": null,
      "date": "2019-12-18",
      "financial_goal": null,
      "projected_amount": null,
      "code": null
    },
    {
      "id": 2661,
      "name": "Alumni Mailing (sample)",
      "description": null,
      "date": "2020-10-18",
      "financial_goal": null,
      "projected_amount": null,
      "code": null
    },
    {
      "id": 2662,
      "name": "Major Donor Email (sample)",
      "description": null,
      "date": "2020-10-18",
      "financial_goal": null,
      "projected_amount": null,
      "code": null
    },
    {
      "id": 2663,
      "name": "Annual Appeal 2020",
      "description": null,
      "date": "2021-07-01",
      "financial_goal": null,
      "projected_amount": null,
      "code": null
    }
  ]
}
                



Campaigns Management

GET /api/v1/campaigns - Fetch Campaigns

Lists all the campaigns.

Parameter Name Description Type Required? Parameter Type
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "name": "",
      "description": "",
      "financial_goal": 0,
      "start_date": "",
      "end_date": "",
      "code": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/campaigns

Query:
limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 4,
  "total_items": 4,
  "limit": 5,
  "offset": 0,
  "item_type": "campaign",
  "items": [
    {
      "id": 819,
      "name": "Annual Giving (sample)",
      "description": null,
      "financial_goal": null,
      "start_date": null,
      "end_date": null,
      "code": null
    },
    {
      "id": 820,
      "name": "Capital Campaign (sample)",
      "description": null,
      "financial_goal": null,
      "start_date": null,
      "end_date": null,
      "code": null
    },
    {
      "id": 821,
      "name": "Scholarship (sample)",
      "description": null,
      "financial_goal": null,
      "start_date": null,
      "end_date": null,
      "code": null
    },
    {
      "id": 822,
      "name": "Annual Giving",
      "description": null,
      "financial_goal": null,
      "start_date": null,
      "end_date": null,
      "code": null
    }
  ]
}
                



Category Management

GET /api/v1/categories - Fetch Categories for Account

Lists all the categories for an account.

Parameter Name Description Type Required? Parameter Type
item_type Categories for type (default: Constituent). Available: Constituent, Gift, VolunteerTime string query
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "item_type": "Constituent",
      "name": "",
      "key": "",
      "facet_type": "",
      "ordinal": 0,
      "removable": true,
      "editable": true,
      "display_format": "",
      "keywords": [
        {
          "id": 0,
          "category_id": 0,
          "name": "",
          "description": "",
          "short_code": "",
          "ordinal": 0,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "",
          "updated_at": ""
        }
      ]
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/categories

Query:
limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 4,
  "total_items": 4,
  "limit": 5,
  "offset": 0,
  "item_type": "category",
  "items": [
    {
      "id": 1041,
      "item_type": "Constituent",
      "name": "Acknowledgment Preference",
      "key": "ack_preferences",
      "facet_type": "single",
      "ordinal": 100,
      "removable": false,
      "editable": true,
      "display_format": "compact",
      "keywords": [
        {
          "id": 12220,
          "category_id": 1041,
          "name": "Prefers mail",
          "description": null,
          "short_code": "ack_pref_mailing",
          "ordinal": 0,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-18T18:06:47Z",
          "updated_at": "2023-09-18T18:06:47Z"
        },
        {
          "id": 12221,
          "category_id": 1041,
          "name": "Prefers email",
          "description": null,
          "short_code": "ack_pref_email",
          "ordinal": 1,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-18T18:06:47Z",
          "updated_at": "2023-09-18T18:06:47Z"
        },
        {
          "id": 12222,
          "category_id": 1041,
          "name": "Prefers none",
          "description": null,
          "short_code": "ack_pref_none",
          "ordinal": 2,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-18T18:06:47Z",
          "updated_at": "2023-09-18T18:06:47Z"
        }
      ]
    },
    {
      "id": 1039,
      "item_type": "Constituent",
      "name": "Communication Tags",
      "key": "tags",
      "facet_type": "list",
      "ordinal": 100,
      "removable": true,
      "editable": true,
      "display_format": "compact",
      "keywords": [
        {
          "id": 12211,
          "category_id": 1039,
          "name": "Do not call",
          "description": null,
          "short_code": "do_not_call",
          "ordinal": 100,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-18T18:06:47Z",
          "updated_at": "2023-09-18T18:06:47Z"
        },
        {
          "id": 12210,
          "category_id": 1039,
          "name": "Do not email",
          "description": null,
          "short_code": "do_not_email",
          "ordinal": 100,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-18T18:06:47Z",
          "updated_at": "2023-09-18T18:06:47Z"
        },
        {
          "id": 12209,
          "category_id": 1039,
          "name": "Do not mail",
          "description": null,
          "short_code": "do_not_mail",
          "ordinal": 100,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-18T18:06:47Z",
          "updated_at": "2023-09-18T18:06:47Z"
        },
        {
          "id": 12225,
          "category_id": 1039,
          "name": "New Tag",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-18T20:48:13Z",
          "updated_at": "2023-09-18T20:48:13Z"
        }
      ]
    },
    {
      "id": 1040,
      "item_type": "Constituent",
      "name": "Giving Status",
      "key": "giving_status",
      "facet_type": "list",
      "ordinal": 100,
      "removable": false,
      "editable": false,
      "display_format": "compact",
      "keywords": [
        {
          "id": 12215,
          "category_id": 1040,
          "name": "Top 100 Donor",
          "description": null,
          "short_code": "top_100_donor",
          "ordinal": 0,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-18T18:06:47Z",
          "updated_at": "2023-09-18T18:06:47Z"
        },
        {
          "id": 12217,
          "category_id": 1040,
          "name": "New Donor",
          "description": null,
          "short_code": "new_donor",
          "ordinal": 1,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-18T18:06:47Z",
          "updated_at": "2023-09-18T18:06:47Z"
        },
        {
          "id": 12216,
          "category_id": 1040,
          "name": "Active Donor",
          "description": null,
          "short_code": "active_donor",
          "ordinal": 2,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-18T18:06:47Z",
          "updated_at": "2023-09-18T18:06:47Z"
        },
        {
          "id": 12218,
          "category_id": 1040,
          "name": "Lapsed Donor",
          "description": null,
          "short_code": "lapsed_donor",
          "ordinal": 3,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-18T18:06:47Z",
          "updated_at": "2023-09-18T18:06:47Z"
        },
        {
          "id": 12219,
          "category_id": 1040,
          "name": "Non Donor",
          "description": null,
          "short_code": "non_donor",
          "ordinal": 4,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-18T18:06:47Z",
          "updated_at": "2023-09-18T18:06:47Z"
        }
      ]
    },
    {
      "id": 1042,
      "item_type": "Constituent",
      "name": "New Custom Category",
      "key": "3fc5a2c0_ba66_43bc_9fc9_17959941bae4",
      "facet_type": "list",
      "ordinal": 100,
      "removable": true,
      "editable": true,
      "display_format": "compact",
      "keywords": [
        {
          "id": 12223,
          "category_id": 1042,
          "name": "val1",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-18T20:20:40Z",
          "updated_at": "2023-09-18T20:20:40Z"
        },
        {
          "id": 12224,
          "category_id": 1042,
          "name": "val2",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-18T20:20:40Z",
          "updated_at": "2023-09-18T20:20:40Z"
        }
      ]
    }
  ]
}
                

Example:

URI: https://api.littlegreenlight.com/api/v1/categories

Query:
item_type=Gift


Response:
                  
{
  "api_version": "1.0",
  "items_count": 1,
  "total_items": 1,
  "limit": 25,
  "offset": 0,
  "item_type": "category",
  "items": [
    {
      "id": 1056,
      "item_type": "Gift",
      "name": "Test Gift Field #2",
      "key": "e0c9cb38_48e9_4515_abde_72a6d93722e6",
      "facet_type": "list",
      "ordinal": 100,
      "removable": true,
      "editable": true,
      "display_format": "compact",
      "keywords": [
        {
          "id": 12252,
          "category_id": 1056,
          "name": "v1",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-19T17:00:48Z",
          "updated_at": "2023-09-19T17:00:48Z"
        },
        {
          "id": 12253,
          "category_id": 1056,
          "name": "v2",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-19T17:00:48Z",
          "updated_at": "2023-09-19T17:00:48Z"
        },
        {
          "id": 12254,
          "category_id": 1056,
          "name": "v3",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-19T17:00:48Z",
          "updated_at": "2023-09-19T17:00:48Z"
        }
      ]
    }
  ]
}
                



POST /api/v1/categories - Create new Category

Add a category to an account.

Parameter Name Description Type Required? Parameter Type
body Create Objects CreateBody true body

CreateBody

CreateBody {
item_type ( string , required ): Item Type,
name ( string , required ): Name,
key ( string , optional ): Key,
facet_type ( string , optional ): Facet Type,
ordinal ( integer , optional ): Ordinal,
removable ( boolean , optional ): Removable?,
editable ( boolean , optional ): Editable?,
display_format ( string , optional ): Display Format
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "item_type": "Constituent",
  "name": "",
  "key": "",
  "facet_type": "",
  "ordinal": 0,
  "removable": true,
  "editable": true,
  "display_format": "",
  "keywords": [
    {
      "id": 0,
      "category_id": 0,
      "name": "",
      "description": "",
      "short_code": "",
      "ordinal": 0,
      "removable": true,
      "can_change": true,
      "can_select": true,
      "created_at": "",
      "updated_at": ""
    }
  ]
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/categories

Body:
                  
{
  "item_type": "Constituent",
  "name": "My Cat",
  "key": "my_cat"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 1090,
  "item_type": "Constituent",
  "name": "My Cat",
  "key": "my_cat",
  "facet_type": "list",
  "ordinal": 100,
  "removable": true,
  "editable": true,
  "display_format": "compact",
  "keywords": [

  ]
}
                



GET /api/v1/categories/{id} - Show Category details

Show details for the category.

Parameter Name Description Type Required? Parameter Type
id Category Id integer true path


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "item_type": "Constituent",
  "name": "",
  "key": "",
  "facet_type": "",
  "ordinal": 0,
  "removable": true,
  "editable": true,
  "display_format": "",
  "keywords": [
    {
      "id": 0,
      "category_id": 0,
      "name": "",
      "description": "",
      "short_code": "",
      "ordinal": 0,
      "removable": true,
      "can_change": true,
      "can_select": true,
      "created_at": "",
      "updated_at": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/categories/1042

Response:
                  
{
  "api_version": "1.0",
  "id": 1042,
  "item_type": "Constituent",
  "name": "New Custom Category",
  "key": "3fc5a2c0_ba66_43bc_9fc9_17959941bae4",
  "facet_type": "list",
  "ordinal": 100,
  "removable": true,
  "editable": true,
  "display_format": "compact",
  "keywords": [
    {
      "id": 12223,
      "category_id": 1042,
      "name": "val1",
      "description": null,
      "short_code": null,
      "ordinal": 100,
      "removable": true,
      "can_change": true,
      "can_select": true,
      "created_at": "2023-09-18T20:20:40Z",
      "updated_at": "2023-09-18T20:20:40Z"
    },
    {
      "id": 12224,
      "category_id": 1042,
      "name": "val2",
      "description": null,
      "short_code": null,
      "ordinal": 100,
      "removable": true,
      "can_change": true,
      "can_select": true,
      "created_at": "2023-09-18T20:20:40Z",
      "updated_at": "2023-09-18T20:20:40Z"
    }
  ]
}
                



PATCH /api/v1/categories/{id} - Update Category

Update the category.

Parameter Name Description Type Required? Parameter Type
id Category Id integer true path
body Update Objects UpdateBody true body

UpdateBody

UpdateBody {
item_type ( string , required ): Item Type,
name ( string , required ): Name,
key ( string , optional ): Key,
facet_type ( string , optional ): Facet Type,
ordinal ( integer , optional ): Ordinal,
removable ( boolean , optional ): Removable?,
editable ( boolean , optional ): Editable?,
display_format ( string , optional ): Display Format
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "item_type": "Constituent",
  "name": "",
  "key": "",
  "facet_type": "",
  "ordinal": 0,
  "removable": true,
  "editable": true,
  "display_format": "",
  "keywords": [
    {
      "id": 0,
      "category_id": 0,
      "name": "",
      "description": "",
      "short_code": "",
      "ordinal": 0,
      "removable": true,
      "can_change": true,
      "can_select": true,
      "created_at": "",
      "updated_at": ""
    }
  ]
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/categories/1090

Body:
                  
{
  "facet_type": "single"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 1090,
  "item_type": "Constituent",
  "name": "My Cat",
  "key": "my_cat",
  "facet_type": "single",
  "ordinal": 100,
  "removable": true,
  "editable": true,
  "display_format": "compact",
  "keywords": [

  ]
}
                



DELETE /api/v1/categories/{id} - Delete Category

Delete the category.

Parameter Name Description Type Required? Parameter Type
id Category Id integer true path


Code Message Response
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/categories/1090

Response:
                  
{
  "api_version": "1.0",
  "result": "success"
}
                



GET /api/v1/constituents/{constituent_id}/categories - Fetch Categories for Constituent

Lists all the categories for a constituent.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "item_type": "Constituent",
      "name": "",
      "key": "",
      "facet_type": "",
      "ordinal": 0,
      "removable": true,
      "editable": true,
      "display_format": "",
      "keywords": [
        {
          "id": 0,
          "category_id": 0,
          "name": "",
          "description": "",
          "short_code": "",
          "ordinal": 0,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "",
          "updated_at": ""
        }
      ]
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/categories

Response:
                  
{
  "api_version": "1.0",
  "items_count": 3,
  "total_items": 3,
  "limit": 25,
  "offset": 0,
  "item_type": "category",
  "items": [
    {
      "id": 1041,
      "item_type": "Constituent",
      "name": "Acknowledgment Preference",
      "key": "ack_preferences",
      "facet_type": "single",
      "ordinal": 100,
      "removable": false,
      "editable": true,
      "display_format": "compact",
      "keywords": [
        {
          "id": 12221,
          "category_id": 1041,
          "name": "Prefers email",
          "description": null,
          "short_code": "ack_pref_email",
          "ordinal": 1,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-18T18:06:47Z",
          "updated_at": "2023-09-18T18:06:47Z"
        }
      ]
    },
    {
      "id": 1040,
      "item_type": "Constituent",
      "name": "Giving Status",
      "key": "giving_status",
      "facet_type": "list",
      "ordinal": 100,
      "removable": false,
      "editable": false,
      "display_format": "compact",
      "keywords": [
        {
          "id": 12216,
          "category_id": 1040,
          "name": "Active Donor",
          "description": null,
          "short_code": "active_donor",
          "ordinal": 2,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-18T18:06:47Z",
          "updated_at": "2023-09-18T18:06:47Z"
        }
      ]
    },
    {
      "id": 1039,
      "item_type": "Constituent",
      "name": "Communication Tags",
      "key": "tags",
      "facet_type": "list",
      "ordinal": 100,
      "removable": true,
      "editable": true,
      "display_format": "compact",
      "keywords": [
        {
          "id": 12211,
          "category_id": 1039,
          "name": "Do not call",
          "description": null,
          "short_code": "do_not_call",
          "ordinal": 100,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-18T18:06:47Z",
          "updated_at": "2023-09-18T18:06:47Z"
        }
      ]
    }
  ]
}
                



Constituent Management

GET /api/v1/constituents/search - Search for Constituents

Search for active constituents.

Parameter Name Description Type Required? Parameter Type
q[] Query String. (EX: name=brady) string true query
expand Expand requested, comma separated, data structures: 'street_addresses, phone_numbers, email_addresses, web_addresses, categories, groups, memberships, custom_attrs' string query
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": 0,
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "external_constituent_id": 0,
      "is_org": true,
      "constituent_contact_type_id": 0,
      "constituent_contact_type_name": "",
      "prefix": "",
      "first_name": "",
      "middle_name": "",
      "last_name": "",
      "suffix": "",
      "spouse_name": "",
      "org_name": "",
      "job_title": "",
      "addressee": "",
      "salutation": "",
      "sort_name": "",
      "constituent_interest_level_id": 0,
      "constituent_interest_level_name": "",
      "constituent_rating_id": 0,
      "constituent_rating_name": "",
      "is_deceased": true,
      "deceased_date": "",
      "annual_report_name": "",
      "birthday": "",
      "gender": "",
      "maiden_name": "",
      "nick_name": "",
      "spouse_nick_name": "",
      "date_added": "",
      "alt_salutation": "",
      "alt_addressee": "",
      "honorary_name": "",
      "assistant_name": "",
      "marital_status_id": 0,
      "marital_status_name": "",
      "is_anon": true,
      "created_at": "",
      "updated_at": ""
    }
  ]
}
                
400 Bad Request
401 Unauthorized
403 Forbidden

Available Search Terms:

Name name Any name field contains term
Email eaddr Email contains term
Phone Number phone_number Phone number contains term
Street Address street Street contains term
city City equals term
state State equals term (2 letter)
postal_code Postal code equals term (matches left most characters)
country Country contains term
Keyword keyword Has keyword ID
Updated At updated_from Date updated from (YYYY-MM-DDTHH:MM:SSZ)
updated_to Date updated to (YYYY-MM-DDTHH:MM:SSZ)
Membership membership_status 0 = Lapsed, 1 = Active
membership_level Comma separated membership_level_ids
membership_end_date_from Latest membership end date from (YYYY-MM-DD)
membership_end_date_to Latest membership end date to (YYYY-MM-DD)
External ID external_id The external_id equals term
Constituent Type constituent_type 0 = Individual, 1 = Organization
Groups groups Comma separated group_ids
Custom Attributes custom_attr "key|op|value"
key: Custom attribute key
op: Operator:
"ft" - contains
"nft" - doesn't contains
"eq" - equals
"ne" - doesn't equal
"sw" - starts with
"bl" - is blank
"nb" - not blank
custom_attr_from "key|YYYY-MM-DD" (Dates)
custom_attr_to "key|YYYY-MM-DD" (Dates)
custom_attr_int "key|op|number[|number2]" (Number, Currency)
key: Custom attribute key
op: Operator:
"gte" - is greater/equal
"lte" - is less/equal
"btw" - is between number and number2
"gt" - is greater than
"lt" - is less than
"eq" - equals
"ne" - doesn't equal

Note: Multiple terms may be combined using a semi-colon: "membership_end_date_from=2018-05-04;membership_end_date_to=2018-05-04"

Example - Search by Name:

URI: https://api.littlegreenlight.com/api/v1/constituents/search

Query:
q[]=name=brady&limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 1,
  "total_items": 1,
  "limit": 5,
  "offset": 0,
  "item_type": "constituent",
  "items": [
    {
      "id": 959508,
      "external_constituent_id": "t00072",
      "is_org": false,
      "constituent_contact_type_id": 1243,
      "constituent_contact_type_name": "Primary",
      "prefix": null,
      "first_name": "Mike",
      "middle_name": null,
      "last_name": "Brady",
      "suffix": null,
      "spouse_name": null,
      "org_name": null,
      "job_title": null,
      "addressee": "Mr. and Mrs. Mike Brady",
      "salutation": "Mike and Carol",
      "sort_name": "Brady, Mike",
      "constituent_interest_level_id": null,
      "constituent_interest_level_name": null,
      "constituent_rating_id": null,
      "constituent_rating_name": null,
      "is_deceased": false,
      "deceased_date": null,
      "annual_report_name": "Mr. and Mrs. Mike Brady",
      "birthday": null,
      "gender": null,
      "maiden_name": null,
      "nick_name": null,
      "spouse_nick_name": null,
      "date_added": "2023-09-18",
      "alt_salutation": "Mike and Carol",
      "alt_addressee": "Mr. and Mrs. Mike Brady",
      "honorary_name": "Mr. and Mrs. Mike Brady",
      "assistant_name": null,
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2023-09-18T18:25:25Z",
      "updated_at": "2023-10-31T18:01:04Z"
    }
  ]
}
                

Example - Search by Name and Expand Address, Phone, and Email Records:

URI: https://api.littlegreenlight.com/api/v1/constituents/search

Query:
q[]=name=brady&expand=street_addresses,phone_numbers,email_addresses&limit=3


Response:
                  
{
  "api_version": "1.0",
  "items_count": 1,
  "total_items": 1,
  "limit": 3,
  "offset": 0,
  "item_type": "constituent",
  "items": [
    {
      "id": 959508,
      "external_constituent_id": "t00072",
      "is_org": false,
      "constituent_contact_type_id": 1243,
      "constituent_contact_type_name": "Primary",
      "prefix": null,
      "first_name": "Mike",
      "middle_name": null,
      "last_name": "Brady",
      "suffix": null,
      "spouse_name": null,
      "org_name": null,
      "job_title": null,
      "addressee": "Mr. and Mrs. Mike Brady",
      "salutation": "Mike and Carol",
      "sort_name": "Brady, Mike",
      "constituent_interest_level_id": null,
      "constituent_interest_level_name": null,
      "constituent_rating_id": null,
      "constituent_rating_name": null,
      "is_deceased": false,
      "deceased_date": null,
      "annual_report_name": "Mr. and Mrs. Mike Brady",
      "birthday": null,
      "gender": null,
      "maiden_name": null,
      "nick_name": null,
      "spouse_nick_name": null,
      "date_added": "2023-09-18",
      "alt_salutation": "Mike and Carol",
      "alt_addressee": "Mr. and Mrs. Mike Brady",
      "honorary_name": "Mr. and Mrs. Mike Brady",
      "assistant_name": null,
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2023-09-18T18:25:25Z",
      "updated_at": "2023-10-31T18:01:04Z",
      "street_addresses": [
        {
          "id": 838407,
          "street": "4222 Clinton Way",
          "city": "Los Angeles",
          "state": "CA",
          "country": "US",
          "postal_code": "90002",
          "county": null,
          "street_address_type_id": 1,
          "street_type_name": "Home",
          "is_preferred": true,
          "not_current": false,
          "parent_id": null,
          "seasonal_from": "01-01",
          "seasonal_to": "12-31",
          "seasonal": null,
          "lat": null,
          "lng": null,
          "zip5": "90002",
          "verified": false,
          "verified_on": null,
          "created_at": "2023-09-18T18:25:25Z",
          "updated_at": "2023-09-18T18:25:25Z"
        }
      ],
      "phone_numbers": [
        {
          "id": 479655,
          "number": "(888) 555-0072",
          "phone_number_type_id": 1,
          "phone_type_name": "Home",
          "is_preferred": true,
          "not_current": false,
          "parent_id": null,
          "normalized_number": "8885550072",
          "created_at": "2023-09-18T18:25:25Z",
          "updated_at": "2023-09-18T18:25:25Z"
        }
      ],
      "email_addresses": [
        {
          "id": 276492,
          "address": "brady@thebradybunch.com",
          "email_address_type_id": 1,
          "email_type_name": "Home",
          "is_preferred": true,
          "not_current": false,
          "parent_id": null,
          "created_at": "2023-09-18T18:25:25Z",
          "updated_at": "2023-09-18T18:25:25Z"
        }
      ]
    }
  ]
}
                

Example - Search by Custom Keyword ID and Updated Since:

URI: https://api.littlegreenlight.com/api/v1/constituents/search

Query:
q[]=keyword=12221;updated_from=2016-01-01&limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 2,
  "total_items": 2,
  "limit": 5,
  "offset": 0,
  "item_type": "constituent",
  "items": [
    {
      "id": 959480,
      "external_constituent_id": "t00044",
      "is_org": false,
      "constituent_contact_type_id": 1243,
      "constituent_contact_type_name": "Primary",
      "prefix": "",
      "first_name": "Larry",
      "middle_name": "",
      "last_name": "Appleton",
      "suffix": "",
      "spouse_name": "",
      "org_name": "Perfect Strangers",
      "job_title": "",
      "addressee": "Larry Appleton and his cousin Balki Bartokomous",
      "salutation": "Larry",
      "sort_name": "Appleton, Larry",
      "constituent_interest_level_id": null,
      "constituent_interest_level_name": null,
      "constituent_rating_id": null,
      "constituent_rating_name": null,
      "is_deceased": false,
      "deceased_date": null,
      "annual_report_name": "Larry Appleton and his cousin Balki Bartokomous",
      "birthday": null,
      "gender": null,
      "maiden_name": "",
      "nick_name": "",
      "spouse_nick_name": "",
      "date_added": "2023-09-18",
      "alt_salutation": "Larry",
      "alt_addressee": "Larry Appleton and his cousin Balki Bartokomous",
      "honorary_name": "Larry Appleton and his cousin Balki Bartokomous",
      "assistant_name": "",
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2023-09-18T18:25:01Z",
      "updated_at": "2023-12-01T17:12:30Z"
    },
    {
      "id": 959453,
      "external_constituent_id": "t00017",
      "is_org": false,
      "constituent_contact_type_id": 1243,
      "constituent_contact_type_name": "Primary",
      "prefix": "",
      "first_name": "Ray",
      "middle_name": "",
      "last_name": "Barone",
      "suffix": "",
      "spouse_name": "",
      "org_name": "Everybody Loves Raymond",
      "job_title": "",
      "addressee": "Barone family",
      "salutation": "Ray",
      "sort_name": "Barone, Ray",
      "constituent_interest_level_id": null,
      "constituent_interest_level_name": null,
      "constituent_rating_id": null,
      "constituent_rating_name": null,
      "is_deceased": false,
      "deceased_date": null,
      "annual_report_name": "Barone family",
      "birthday": null,
      "gender": null,
      "maiden_name": "",
      "nick_name": "",
      "spouse_nick_name": "",
      "date_added": "2023-09-18",
      "alt_salutation": "Ray",
      "alt_addressee": "Barone family",
      "honorary_name": "Barone family",
      "assistant_name": "",
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2023-09-18T18:24:43Z",
      "updated_at": "2023-10-31T18:01:04Z"
    }
  ]
}
                

Example - Search For Organizations:

URI: https://api.littlegreenlight.com/api/v1/constituents/search

Query:
q[]=constituent_type=1&limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 5,
  "total_items": 8,
  "limit": 5,
  "offset": 0,
  "next_item": 5,
  "next_link": "https://api.littlegreenlight.com/api/v1/constituents/search?limit=5&offset=5&q%5B%5D=constituent_type%3D1",
  "item_type": "constituent",
  "items": [
    {
      "id": 959440,
      "external_constituent_id": "t00004",
      "is_org": true,
      "constituent_contact_type_id": 1243,
      "constituent_contact_type_name": "Primary",
      "prefix": null,
      "first_name": null,
      "middle_name": null,
      "last_name": "Mansion",
      "suffix": null,
      "spouse_name": null,
      "org_name": "Avengers Mansion Headquarters of the Avengers",
      "job_title": null,
      "addressee": "Headquarters of the Avengers",
      "salutation": null,
      "sort_name": "Avengers Mansion Headquarters of the Avengers",
      "constituent_interest_level_id": null,
      "constituent_interest_level_name": null,
      "constituent_rating_id": null,
      "constituent_rating_name": null,
      "is_deceased": false,
      "deceased_date": null,
      "annual_report_name": null,
      "birthday": null,
      "gender": null,
      "maiden_name": null,
      "nick_name": null,
      "spouse_nick_name": null,
      "date_added": "2023-09-18",
      "alt_salutation": null,
      "alt_addressee": "Headquarters of the Avengers",
      "honorary_name": null,
      "assistant_name": null,
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2023-09-18T18:24:35Z",
      "updated_at": "2023-10-31T18:01:04Z"
    },
    {
      "id": 959513,
      "external_constituent_id": "t00077",
      "is_org": true,
      "constituent_contact_type_id": 1243,
      "constituent_contact_type_name": "Primary",
      "prefix": null,
      "first_name": null,
      "middle_name": null,
      "last_name": "Cheers",
      "suffix": null,
      "spouse_name": null,
      "org_name": "Cheers",
      "job_title": null,
      "addressee": "Cheers",
      "salutation": "Cheers",
      "sort_name": "Cheers",
      "constituent_interest_level_id": null,
      "constituent_interest_level_name": null,
      "constituent_rating_id": null,
      "constituent_rating_name": null,
      "is_deceased": false,
      "deceased_date": null,
      "annual_report_name": "Cheers",
      "birthday": null,
      "gender": null,
      "maiden_name": null,
      "nick_name": null,
      "spouse_nick_name": null,
      "date_added": "2023-09-18",
      "alt_salutation": "Cheers",
      "alt_addressee": "Cheers",
      "honorary_name": "Cheers",
      "assistant_name": null,
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2023-09-18T18:25:29Z",
      "updated_at": "2023-10-31T18:01:04Z"
    },
    {
      "id": 959450,
      "external_constituent_id": "t00014",
      "is_org": true,
      "constituent_contact_type_id": 1243,
      "constituent_contact_type_name": "Primary",
      "prefix": null,
      "first_name": null,
      "middle_name": null,
      "last_name": "Sugarbaker",
      "suffix": null,
      "spouse_name": null,
      "org_name": "Designing Women",
      "job_title": null,
      "addressee": "Sugarbaker Design Firm",
      "salutation": null,
      "sort_name": "Designing Women",
      "constituent_interest_level_id": null,
      "constituent_interest_level_name": null,
      "constituent_rating_id": null,
      "constituent_rating_name": null,
      "is_deceased": false,
      "deceased_date": null,
      "annual_report_name": null,
      "birthday": null,
      "gender": null,
      "maiden_name": null,
      "nick_name": null,
      "spouse_nick_name": null,
      "date_added": "2023-09-18",
      "alt_salutation": null,
      "alt_addressee": "Sugarbaker Design Firm",
      "honorary_name": null,
      "assistant_name": null,
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2023-09-18T18:24:41Z",
      "updated_at": "2023-10-31T18:01:05Z"
    },
    {
      "id": 959471,
      "external_constituent_id": "t00035",
      "is_org": true,
      "constituent_contact_type_id": 1243,
      "constituent_contact_type_name": "Primary",
      "prefix": null,
      "first_name": null,
      "middle_name": null,
      "last_name": "Laverne & Shirley",
      "suffix": null,
      "spouse_name": null,
      "org_name": "Laverne & Shirley",
      "job_title": null,
      "addressee": "Laverne & Shirley",
      "salutation": null,
      "sort_name": "Laverne & Shirley",
      "constituent_interest_level_id": null,
      "constituent_interest_level_name": null,
      "constituent_rating_id": null,
      "constituent_rating_name": null,
      "is_deceased": false,
      "deceased_date": null,
      "annual_report_name": null,
      "birthday": null,
      "gender": null,
      "maiden_name": null,
      "nick_name": null,
      "spouse_nick_name": null,
      "date_added": "2023-09-18",
      "alt_salutation": null,
      "alt_addressee": "Laverne & Shirley",
      "honorary_name": null,
      "assistant_name": null,
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2023-09-18T18:24:54Z",
      "updated_at": "2023-10-31T18:01:06Z"
    },
    {
      "id": 959478,
      "external_constituent_id": "t00042",
      "is_org": true,
      "constituent_contact_type_id": 1243,
      "constituent_contact_type_name": "Primary",
      "prefix": null,
      "first_name": null,
      "middle_name": null,
      "last_name": "Phil's",
      "suffix": null,
      "spouse_name": null,
      "org_name": "Murphy Brown",
      "job_title": null,
      "addressee": "Phil's Bar & Grill",
      "salutation": null,
      "sort_name": "Murphy Brown",
      "constituent_interest_level_id": null,
      "constituent_interest_level_name": null,
      "constituent_rating_id": null,
      "constituent_rating_name": null,
      "is_deceased": false,
      "deceased_date": null,
      "annual_report_name": null,
      "birthday": null,
      "gender": null,
      "maiden_name": null,
      "nick_name": null,
      "spouse_nick_name": null,
      "date_added": "2023-09-18",
      "alt_salutation": null,
      "alt_addressee": "Phil's Bar & Grill",
      "honorary_name": null,
      "assistant_name": null,
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2023-09-18T18:25:00Z",
      "updated_at": "2023-10-31T18:01:06Z"
    }
  ]
}
                

Example - Search Full Text of Custom Attribute:

URI: https://api.littlegreenlight.com/api/v1/constituents/search

Query:
q[]=custom_attr=background_info|ft|Ck returned&limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 1,
  "total_items": 1,
  "limit": 5,
  "offset": 0,
  "item_type": "constituent",
  "items": [
    {
      "id": 959448,
      "external_constituent_id": "t00012",
      "is_org": false,
      "constituent_contact_type_id": 1243,
      "constituent_contact_type_name": "Primary",
      "prefix": "",
      "first_name": "Susan",
      "middle_name": "",
      "last_name": "Alexander",
      "suffix": "",
      "spouse_name": "",
      "org_name": "Citizen Kane",
      "job_title": "",
      "addressee": "Mrs. Susan Alexander",
      "salutation": "Susan",
      "sort_name": "Alexander, Susan",
      "constituent_interest_level_id": null,
      "constituent_interest_level_name": null,
      "constituent_rating_id": null,
      "constituent_rating_name": null,
      "is_deceased": false,
      "deceased_date": null,
      "annual_report_name": "Mrs. Susan Alexander",
      "birthday": null,
      "gender": null,
      "maiden_name": "",
      "nick_name": "",
      "spouse_nick_name": "",
      "date_added": "2023-09-18",
      "alt_salutation": "Susan",
      "alt_addressee": "Mrs. Susan Alexander",
      "honorary_name": "Mrs. Susan Alexander",
      "assistant_name": "",
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2023-09-18T18:24:41Z",
      "updated_at": "2023-10-31T17:53:29Z"
    }
  ]
}
                

Example - Search Between Numbers for Custom Attribute:

URI: https://api.littlegreenlight.com/api/v1/constituents/search

Query:
q[]=custom_attr_int=test_number|btw|5|50&limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 1,
  "total_items": 1,
  "limit": 5,
  "offset": 0,
  "item_type": "constituent",
  "items": [
    {
      "id": 959456,
      "external_constituent_id": "t00020",
      "is_org": false,
      "constituent_contact_type_id": 1243,
      "constituent_contact_type_name": "Primary",
      "prefix": "",
      "first_name": "Ferris",
      "middle_name": "",
      "last_name": "Bueller",
      "suffix": "",
      "spouse_name": "",
      "org_name": "Ferris Bueller's Day Off",
      "job_title": "",
      "addressee": "Bueller family",
      "salutation": "Ferris",
      "sort_name": "Bueller, Ferris",
      "constituent_interest_level_id": null,
      "constituent_interest_level_name": null,
      "constituent_rating_id": null,
      "constituent_rating_name": null,
      "is_deceased": false,
      "deceased_date": null,
      "annual_report_name": "Bueller family",
      "birthday": null,
      "gender": null,
      "maiden_name": "",
      "nick_name": "",
      "spouse_nick_name": "",
      "date_added": "2023-09-18",
      "alt_salutation": "Ferris",
      "alt_addressee": "Bueller family",
      "honorary_name": "Bueller family",
      "assistant_name": "",
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2023-09-18T18:24:45Z",
      "updated_at": "2023-10-31T18:01:04Z"
    }
  ]
}
                

Example - Unknown Parameter Error:

URI: https://api.littlegreenlight.com/api/v1/constituents/search

Query:
q[]=badterm=1&limit=5


Response:
                  
{
  "api_version": "1.0",
  "error": "Parameter Error",
  "description": "Unknown query parameter: badterm"
}
                



GET /api/v1/constituents - Fetch all Constituents for an account

This lists all the active constituents for an account.

Parameter Name Description Type Required? Parameter Type
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": 0,
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "external_constituent_id": 0,
      "is_org": true,
      "constituent_contact_type_id": 0,
      "constituent_contact_type_name": "",
      "prefix": "",
      "first_name": "",
      "middle_name": "",
      "last_name": "",
      "suffix": "",
      "spouse_name": "",
      "org_name": "",
      "job_title": "",
      "addressee": "",
      "salutation": "",
      "sort_name": "",
      "constituent_interest_level_id": 0,
      "constituent_interest_level_name": "",
      "constituent_rating_id": 0,
      "constituent_rating_name": "",
      "is_deceased": true,
      "deceased_date": "",
      "annual_report_name": "",
      "birthday": "",
      "gender": "",
      "maiden_name": "",
      "nick_name": "",
      "spouse_nick_name": "",
      "date_added": "",
      "alt_salutation": "",
      "alt_addressee": "",
      "honorary_name": "",
      "assistant_name": "",
      "marital_status_id": 0,
      "marital_status_name": "",
      "is_anon": true,
      "created_at": "",
      "updated_at": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents

Query:
limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 5,
  "total_items": 84,
  "limit": 5,
  "offset": 0,
  "next_item": 5,
  "next_link": "https://api.littlegreenlight.com/api/v1/constituents?limit=5&offset=5",
  "item_type": "constituent",
  "items": [
    {
      "id": 959448,
      "external_constituent_id": "t00012",
      "is_org": false,
      "constituent_contact_type_id": 1243,
      "constituent_contact_type_name": "Primary",
      "prefix": "",
      "first_name": "Susan",
      "middle_name": "",
      "last_name": "Alexander",
      "suffix": "",
      "spouse_name": "",
      "org_name": "Citizen Kane",
      "job_title": "",
      "addressee": "Mrs. Susan Alexander",
      "salutation": "Susan",
      "sort_name": "Alexander, Susan",
      "constituent_interest_level_id": null,
      "constituent_interest_level_name": null,
      "constituent_rating_id": null,
      "constituent_rating_name": null,
      "is_deceased": false,
      "deceased_date": null,
      "annual_report_name": "Mrs. Susan Alexander",
      "birthday": null,
      "gender": null,
      "maiden_name": "",
      "nick_name": "",
      "spouse_nick_name": "",
      "date_added": "2023-09-18",
      "alt_salutation": "Susan",
      "alt_addressee": "Mrs. Susan Alexander",
      "honorary_name": "Mrs. Susan Alexander",
      "assistant_name": "",
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2023-09-18T18:24:41Z",
      "updated_at": "2023-10-31T17:53:29Z"
    },
    {
      "id": 959480,
      "external_constituent_id": "t00044",
      "is_org": false,
      "constituent_contact_type_id": 1243,
      "constituent_contact_type_name": "Primary",
      "prefix": "",
      "first_name": "Larry",
      "middle_name": "",
      "last_name": "Appleton",
      "suffix": "",
      "spouse_name": "",
      "org_name": "Perfect Strangers",
      "job_title": "",
      "addressee": "Larry Appleton and his cousin Balki Bartokomous",
      "salutation": "Larry",
      "sort_name": "Appleton, Larry",
      "constituent_interest_level_id": null,
      "constituent_interest_level_name": null,
      "constituent_rating_id": null,
      "constituent_rating_name": null,
      "is_deceased": false,
      "deceased_date": null,
      "annual_report_name": "Larry Appleton and his cousin Balki Bartokomous",
      "birthday": null,
      "gender": null,
      "maiden_name": "",
      "nick_name": "",
      "spouse_nick_name": "",
      "date_added": "2023-09-18",
      "alt_salutation": "Larry",
      "alt_addressee": "Larry Appleton and his cousin Balki Bartokomous",
      "honorary_name": "Larry Appleton and his cousin Balki Bartokomous",
      "assistant_name": "",
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2023-09-18T18:25:01Z",
      "updated_at": "2023-12-01T17:12:30Z"
    },
    {
      "id": 959486,
      "external_constituent_id": "t00050",
      "is_org": false,
      "constituent_contact_type_id": 1243,
      "constituent_contact_type_name": "Primary",
      "prefix": null,
      "first_name": null,
      "middle_name": null,
      "last_name": "Archer's",
      "suffix": null,
      "spouse_name": null,
      "org_name": "series of novels",
      "job_title": null,
      "addressee": "Lew Archer's office",
      "salutation": "Archer's",
      "sort_name": "Archer's",
      "constituent_interest_level_id": null,
      "constituent_interest_level_name": null,
      "constituent_rating_id": null,
      "constituent_rating_name": null,
      "is_deceased": false,
      "deceased_date": null,
      "annual_report_name": "Lew Archer's office",
      "birthday": null,
      "gender": null,
      "maiden_name": null,
      "nick_name": null,
      "spouse_nick_name": null,
      "date_added": "2023-09-18",
      "alt_salutation": "Archer's",
      "alt_addressee": "Lew Archer's office",
      "honorary_name": "Lew Archer's office",
      "assistant_name": null,
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2023-09-18T18:25:11Z",
      "updated_at": "2023-10-31T18:01:04Z"
    },
    {
      "id": 959440,
      "external_constituent_id": "t00004",
      "is_org": true,
      "constituent_contact_type_id": 1243,
      "constituent_contact_type_name": "Primary",
      "prefix": null,
      "first_name": null,
      "middle_name": null,
      "last_name": "Mansion",
      "suffix": null,
      "spouse_name": null,
      "org_name": "Avengers Mansion Headquarters of the Avengers",
      "job_title": null,
      "addressee": "Headquarters of the Avengers",
      "salutation": null,
      "sort_name": "Avengers Mansion Headquarters of the Avengers",
      "constituent_interest_level_id": null,
      "constituent_interest_level_name": null,
      "constituent_rating_id": null,
      "constituent_rating_name": null,
      "is_deceased": false,
      "deceased_date": null,
      "annual_report_name": null,
      "birthday": null,
      "gender": null,
      "maiden_name": null,
      "nick_name": null,
      "spouse_nick_name": null,
      "date_added": "2023-09-18",
      "alt_salutation": null,
      "alt_addressee": "Headquarters of the Avengers",
      "honorary_name": null,
      "assistant_name": null,
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2023-09-18T18:24:35Z",
      "updated_at": "2023-10-31T18:01:04Z"
    },
    {
      "id": 959453,
      "external_constituent_id": "t00017",
      "is_org": false,
      "constituent_contact_type_id": 1243,
      "constituent_contact_type_name": "Primary",
      "prefix": "",
      "first_name": "Ray",
      "middle_name": "",
      "last_name": "Barone",
      "suffix": "",
      "spouse_name": "",
      "org_name": "Everybody Loves Raymond",
      "job_title": "",
      "addressee": "Barone family",
      "salutation": "Ray",
      "sort_name": "Barone, Ray",
      "constituent_interest_level_id": null,
      "constituent_interest_level_name": null,
      "constituent_rating_id": null,
      "constituent_rating_name": null,
      "is_deceased": false,
      "deceased_date": null,
      "annual_report_name": "Barone family",
      "birthday": null,
      "gender": null,
      "maiden_name": "",
      "nick_name": "",
      "spouse_nick_name": "",
      "date_added": "2023-09-18",
      "alt_salutation": "Ray",
      "alt_addressee": "Barone family",
      "honorary_name": "Barone family",
      "assistant_name": "",
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2023-09-18T18:24:43Z",
      "updated_at": "2023-10-31T18:01:04Z"
    }
  ]
}
                



POST /api/v1/constituents - Create new Constituent

Add a Constituent to an account along with related objects.

Parameter Name Description Type Required? Parameter Type
body Create Objects CreateBody true body

CreateBody

CreateBody {
external_constituent_id ( integer , optional ): External constituent ID,
is_org ( boolean , optional ): This constituent is an organization or company,
constituent_contact_type_id ( integer , optional ): Constituent contact type ID,
constituent_contact_type_name ( string , optional ): Constituent contact type,
prefix ( string , optional ): Prefix,
first_name ( string , required ): First name,
middle_name ( string , optional ): Middle name,
last_name ( string , required ): Last name,
suffix ( string , optional ): Suffix,
spouse_name ( string , optional ): Spouse/Partner,
org_name ( string , optional ): Organization name,
job_title ( string , optional ): Job title,
addressee ( string , optional ): Addressee/Label name,
salutation ( string , optional ): Salutation,
is_deceased ( boolean , optional ): Deceased?,
deceased_date ( string , optional ): Deceased date,
annual_report_name ( string , optional ): Annual report name,
birthday ( date , optional ): Birthday,
gender ( string , optional ): Gender,
maiden_name ( string , optional ): Maiden name,
nick_name ( string , optional ): Nickname,
spouse_nick_name ( string , optional ): Spouse nickname,
date_added ( date , optional ): Date added,
alt_salutation ( string , optional ): Alt salutation,
alt_addressee ( string , optional ): Alt addressee,
honorary_name ( string , optional ): Honorary name,
assistant_name ( string , optional ): Assistant name,
marital_status_id ( integer , optional ): Marital status ID,
marital_status_name ( string , optional ): Marital status,
is_anon ( boolean , optional ): Gives anonymously?,
email_addresses ( array , required , EmailAddress ): Email Address Objects,
phone_numbers ( array , optional , PhoneNumber ): Phone Number Objects,
street_addresses ( array , optional , StreetAddress ): Street Address Objects,
web_addresses ( array , optional , WebAddress ): Web Address Objects,
categories ( array , optional , CategoryAggregatedCreate ): Constituent Categories,
groups ( array , optional , GroupMembership ): Group Objects,
custom_attrs ( array , optional , CustomAttr_create ): Custom Attrubute Objects
}
EmailAddress {
address ( string , optional ): Email Address,
email_address_type_id ( integer , optional ): Email Address Type ID,
email_type_name ( string , optional ): Email Address Type Name,
is_preferred ( boolean , optional ): Make this the preferred email address,
not_current ( boolean , optional ): No longer a current email address
}
PhoneNumber {
number ( string , optional ): Phone Number,
phone_number_type_id ( integer , optional ): Phone Number Type Id,
phone_type_name ( string , optional ): Phone Number Type Name,
is_preferred ( boolean , optional ): Make this the preferred phone number,
not_current ( boolean , optional ): No longer a current phone number
}
StreetAddress {
street ( string , optional ): Street,
street_address_type_id ( integer , optional ): Street Address Type ID,
street_type_name ( string , optional ): Street Address Type Name,
city ( string , optional ): City,
state ( string , optional ): State/Province,
postal_code ( string , optional ): Zip/Postal Code,
county ( string , optional ): County,
country ( string , optional ): Country,
seasonal_from ( string , optional ): Seasonal from (mm-dd),
seasonal_to ( string , optional ): Seasonal to (mm-dd),
seasonal ( boolean , optional ): Is seasonal?,
is_preferred ( boolean , optional ): Is preferred address,
not_current ( boolean , optional ): Not current?
}
WebAddress {
url ( string , optional ): Web Address,
web_address_type_id ( integer , optional ): Web Address Type ID,
web_address_type_name ( string , optional ): Web Address Type Name,
is_preferred ( boolean , optional ): Make this the preferred email address
}
CategoryAggregatedCreate {
id ( integer , optional ): Category Id,
name ( string , required ): Name,
key ( string , optional ): Key,
keywords ( array , required , KeywordAggregatedUpdate ): Keyword Values
}
KeywordAggregatedUpdate {
id ( integer , required ): Keyword Id,
name ( string , required ): Name,
short_code ( string , optional ): Short Code
}
GroupMembership {
group_id ( integer , required ): Group Id,
group_name ( string , optional ): Group Name,
date_start ( date , optional ): Start Date,
date_end ( date , optional ): End Date,
is_current ( boolean , optional ): Current?
}
CustomAttr_create {
id ( integer , optional ): Custom Field Id,
key ( string , optional ): Key,
value ( string , required ): Value
}


Code Message Response
200 Ok
                  
{
  "api_version": 0,
  "id": 0,
  "external_constituent_id": 0,
  "is_org": true,
  "constituent_contact_type_id": 0,
  "constituent_contact_type_name": "",
  "prefix": "",
  "first_name": "",
  "middle_name": "",
  "last_name": "",
  "suffix": "",
  "spouse_name": "",
  "org_name": "",
  "job_title": "",
  "addressee": "",
  "salutation": "",
  "sort_name": "",
  "constituent_interest_level_id": 0,
  "constituent_interest_level_name": "",
  "constituent_rating_id": 0,
  "constituent_rating_name": "",
  "is_deceased": true,
  "deceased_date": "",
  "annual_report_name": "",
  "birthday": "",
  "gender": "",
  "maiden_name": "",
  "nick_name": "",
  "spouse_nick_name": "",
  "date_added": "",
  "alt_salutation": "",
  "alt_addressee": "",
  "honorary_name": "",
  "assistant_name": "",
  "marital_status_id": 0,
  "marital_status_name": "",
  "is_anon": true,
  "created_at": "",
  "updated_at": "",
  "email_addresses": [
    {
      "id": 0,
      "address": "",
      "email_address_type_id": 1,
      "email_type_name": "Home",
      "is_preferred": true,
      "not_current": true,
      "created_at": "",
      "updated_at": ""
    }
  ],
  "phone_numbers": [
    {
      "id": 0,
      "number": "",
      "phone_number_type_id": 1,
      "phone_type_name": "Home",
      "is_preferred": true,
      "not_current": true,
      "created_at": "",
      "updated_at": ""
    }
  ],
  "street_addresses": [
    {
      "id": 0,
      "street": "",
      "city": "",
      "state": "",
      "country": "",
      "postal_code": "",
      "county": "",
      "street_address_type_id": 1,
      "street_type_name": "Home",
      "is_preferred": true,
      "not_current": true,
      "seasonal_from": "01-01",
      "seasonal_to": "12-31",
      "seasonal": true,
      "lat": "",
      "lng": "",
      "zip5": "",
      "verified": true,
      "verified_on": "",
      "created_at": "",
      "updated_at": ""
    }
  ],
  "web_addresses": [
    {
      "id": 0,
      "url": "",
      "web_address_type_id": 0,
      "web_address_type_name": "",
      "is_preferred": true,
      "created_at": "",
      "updated_at": ""
    }
  ],
  "categories": [
    {
      "id": 0,
      "item_type": "Constituent",
      "name": "",
      "key": "",
      "facet_type": "",
      "ordinal": 0,
      "removable": true,
      "editable": true,
      "display_format": "",
      "keywords": [
        {
          "id": 0,
          "category_id": 0,
          "name": "",
          "description": "",
          "short_code": "",
          "ordinal": 0,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "",
          "updated_at": ""
        }
      ]
    }
  ],
  "groups": [
    {
      "id": 0,
      "constituent_id": 0,
      "group_id": 0,
      "group_name": "",
      "date_start": "",
      "date_end": "",
      "is_current": true,
      "created_at": "",
      "updated_at": ""
    }
  ],
  "memberships": [
    {
      "id": 0,
      "constituent_id": 0,
      "membership_level_id": 0,
      "membership_level_name": "",
      "date_start": "",
      "finish_date": "",
      "note": "",
      "created_at": "",
      "updated_at": ""
    }
  ],
  "custom_attrs": [
    {
      "id": 0,
      "classification": "",
      "name": "",
      "key": "",
      "ordinal": 0,
      "value": ""
    }
  ]
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents

Body:
                  
{
  "is_org": false,
  "external_constituent_id": "999",
  "first_name": "Joe",
  "last_name": "Doe",
  "email_addresses": [
    {
      "address": "joed@example.com"
    }
  ],
  "categories": [
    {
      "key": "tags",
      "keywords": [
        {
          "name": "New Tag"
        }
      ]
    }
  ],
  "groups": [
    {
      "group_name": "Board Member"
    }
  ],
  "custom_attrs": [
    {
      "key": "background_info",
      "value": "Founding member"
    }
  ]
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 959566,
  "external_constituent_id": "999",
  "is_org": false,
  "constituent_contact_type_id": 1243,
  "constituent_contact_type_name": "Primary",
  "prefix": null,
  "first_name": "Joe",
  "middle_name": null,
  "last_name": "Doe",
  "suffix": null,
  "spouse_name": null,
  "org_name": null,
  "job_title": null,
  "addressee": "Joe Doe",
  "salutation": "Joe",
  "sort_name": "Doe, Joe",
  "constituent_interest_level_id": null,
  "constituent_interest_level_name": null,
  "constituent_rating_id": null,
  "constituent_rating_name": null,
  "is_deceased": false,
  "deceased_date": null,
  "annual_report_name": "Joe Doe",
  "birthday": null,
  "gender": null,
  "maiden_name": null,
  "nick_name": null,
  "spouse_nick_name": null,
  "date_added": "2024-02-06",
  "alt_salutation": "Joe",
  "alt_addressee": "Joe Doe",
  "honorary_name": "Joe Doe",
  "assistant_name": null,
  "marital_status_id": null,
  "marital_status_name": null,
  "is_anon": false,
  "created_at": "2024-02-06T15:58:12Z",
  "updated_at": "2024-02-06T15:58:12Z",
  "street_addresses": [

  ],
  "phone_numbers": [

  ],
  "email_addresses": [
    {
      "id": 276595,
      "address": "joed@example.com",
      "email_address_type_id": 1,
      "email_type_name": "Home",
      "is_preferred": true,
      "not_current": false,
      "parent_id": null,
      "created_at": "2024-02-06T15:58:12Z",
      "updated_at": "2024-02-06T15:58:12Z"
    }
  ],
  "web_addresses": [

  ],
  "categories": [
    {
      "id": 1039,
      "item_type": "Constituent",
      "name": "Communication Tags",
      "key": "tags",
      "facet_type": "list",
      "ordinal": 100,
      "removable": true,
      "editable": true,
      "display_format": "compact",
      "keywords": [
        {
          "id": 12225,
          "category_id": 1039,
          "name": "New Tag",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-18T20:48:13Z",
          "updated_at": "2023-09-18T20:48:13Z"
        }
      ]
    }
  ],
  "groups": [
    {
      "id": 595500,
      "constituent_id": 959566,
      "group_id": 3241,
      "group_name": "Board Member",
      "date_start": null,
      "date_end": null,
      "is_current": true,
      "created_at": "2024-02-06T15:58:12Z",
      "updated_at": "2024-02-06T15:58:12Z"
    }
  ],
  "memberships": [

  ],
  "custom_attrs": [
    {
      "id": 514928,
      "classification": "text",
      "name": "Background Info",
      "key": "background_info",
      "ordinal": 100,
      "value": "Founding member"
    }
  ]
}
                



GET /api/v1/constituents/{id} - Show Constituent details

Show details for the constituent.

Parameter Name Description Type Required? Parameter Type
id Constituent Id integer true path


Code Message Response
200 Ok
                  
{
  "api_version": 0,
  "id": 0,
  "external_constituent_id": 0,
  "is_org": true,
  "constituent_contact_type_id": 0,
  "constituent_contact_type_name": "",
  "prefix": "",
  "first_name": "",
  "middle_name": "",
  "last_name": "",
  "suffix": "",
  "spouse_name": "",
  "org_name": "",
  "job_title": "",
  "addressee": "",
  "salutation": "",
  "sort_name": "",
  "constituent_interest_level_id": 0,
  "constituent_interest_level_name": "",
  "constituent_rating_id": 0,
  "constituent_rating_name": "",
  "is_deceased": true,
  "deceased_date": "",
  "annual_report_name": "",
  "birthday": "",
  "gender": "",
  "maiden_name": "",
  "nick_name": "",
  "spouse_nick_name": "",
  "date_added": "",
  "alt_salutation": "",
  "alt_addressee": "",
  "honorary_name": "",
  "assistant_name": "",
  "marital_status_id": 0,
  "marital_status_name": "",
  "is_anon": true,
  "created_at": "",
  "updated_at": "",
  "email_addresses": [
    {
      "id": 0,
      "address": "",
      "email_address_type_id": 1,
      "email_type_name": "Home",
      "is_preferred": true,
      "not_current": true,
      "created_at": "",
      "updated_at": ""
    }
  ],
  "phone_numbers": [
    {
      "id": 0,
      "number": "",
      "phone_number_type_id": 1,
      "phone_type_name": "Home",
      "is_preferred": true,
      "not_current": true,
      "created_at": "",
      "updated_at": ""
    }
  ],
  "street_addresses": [
    {
      "id": 0,
      "street": "",
      "city": "",
      "state": "",
      "country": "",
      "postal_code": "",
      "county": "",
      "street_address_type_id": 1,
      "street_type_name": "Home",
      "is_preferred": true,
      "not_current": true,
      "seasonal_from": "01-01",
      "seasonal_to": "12-31",
      "seasonal": true,
      "lat": "",
      "lng": "",
      "zip5": "",
      "verified": true,
      "verified_on": "",
      "created_at": "",
      "updated_at": ""
    }
  ],
  "web_addresses": [
    {
      "id": 0,
      "url": "",
      "web_address_type_id": 0,
      "web_address_type_name": "",
      "is_preferred": true,
      "created_at": "",
      "updated_at": ""
    }
  ],
  "categories": [
    {
      "id": 0,
      "item_type": "Constituent",
      "name": "",
      "key": "",
      "facet_type": "",
      "ordinal": 0,
      "removable": true,
      "editable": true,
      "display_format": "",
      "keywords": [
        {
          "id": 0,
          "category_id": 0,
          "name": "",
          "description": "",
          "short_code": "",
          "ordinal": 0,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "",
          "updated_at": ""
        }
      ]
    }
  ],
  "groups": [
    {
      "id": 0,
      "constituent_id": 0,
      "group_id": 0,
      "group_name": "",
      "date_start": "",
      "date_end": "",
      "is_current": true,
      "created_at": "",
      "updated_at": ""
    }
  ],
  "memberships": [
    {
      "id": 0,
      "constituent_id": 0,
      "membership_level_id": 0,
      "membership_level_name": "",
      "date_start": "",
      "finish_date": "",
      "note": "",
      "created_at": "",
      "updated_at": ""
    }
  ],
  "custom_attrs": [
    {
      "id": 0,
      "classification": "",
      "name": "",
      "key": "",
      "ordinal": 0,
      "value": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480

Response:
                  
{
  "api_version": "1.0",
  "id": 959480,
  "external_constituent_id": "t00044",
  "is_org": false,
  "constituent_contact_type_id": 1243,
  "constituent_contact_type_name": "Primary",
  "prefix": "",
  "first_name": "Larry",
  "middle_name": "",
  "last_name": "Appleton",
  "suffix": "",
  "spouse_name": "",
  "org_name": "Perfect Strangers",
  "job_title": "",
  "addressee": "Larry Appleton and his cousin Balki Bartokomous",
  "salutation": "Larry",
  "sort_name": "Appleton, Larry",
  "constituent_interest_level_id": null,
  "constituent_interest_level_name": null,
  "constituent_rating_id": null,
  "constituent_rating_name": null,
  "is_deceased": false,
  "deceased_date": null,
  "annual_report_name": "Larry Appleton and his cousin Balki Bartokomous",
  "birthday": null,
  "gender": null,
  "maiden_name": "",
  "nick_name": "",
  "spouse_nick_name": "",
  "date_added": "2023-09-18",
  "alt_salutation": "Larry",
  "alt_addressee": "Larry Appleton and his cousin Balki Bartokomous",
  "honorary_name": "Larry Appleton and his cousin Balki Bartokomous",
  "assistant_name": "",
  "marital_status_id": null,
  "marital_status_name": null,
  "is_anon": false,
  "created_at": "2023-09-18T18:25:01Z",
  "updated_at": "2023-12-01T17:12:30Z",
  "street_addresses": [
    {
      "id": 838379,
      "street": "711 Calhoun Street",
      "city": "Chicago",
      "state": "IL",
      "country": "US",
      "postal_code": "60603",
      "county": "",
      "street_address_type_id": 1,
      "street_type_name": "Home",
      "is_preferred": true,
      "not_current": false,
      "parent_id": null,
      "seasonal_from": "01-01",
      "seasonal_to": "12-31",
      "seasonal": null,
      "lat": null,
      "lng": null,
      "zip5": "60603",
      "verified": false,
      "verified_on": null,
      "created_at": "2023-09-18T18:25:01Z",
      "updated_at": "2023-09-19T22:34:56Z"
    }
  ],
  "phone_numbers": [
    {
      "id": 479627,
      "number": "(888) 555-0044",
      "phone_number_type_id": 3,
      "phone_type_name": "Mobile",
      "is_preferred": true,
      "not_current": false,
      "parent_id": null,
      "normalized_number": "8885550044",
      "created_at": "2023-09-18T18:25:01Z",
      "updated_at": "2023-09-19T22:34:56Z"
    }
  ],
  "email_addresses": [
    {
      "id": 276464,
      "address": "appleton@perfectstrangers.com",
      "email_address_type_id": 1,
      "email_type_name": "Home",
      "is_preferred": true,
      "not_current": false,
      "parent_id": null,
      "created_at": "2023-09-18T18:25:01Z",
      "updated_at": "2023-09-19T22:34:56Z"
    }
  ],
  "web_addresses": [
    {
      "id": 46,
      "url": "www.website.com",
      "web_address_type_id": 5,
      "web_address_type_name": "Website",
      "is_preferred": false,
      "parent_id": null,
      "created_at": "2023-09-19T22:34:56Z",
      "updated_at": "2023-09-19T22:34:56Z"
    },
    {
      "id": 47,
      "url": "facebook.com/something",
      "web_address_type_id": 6,
      "web_address_type_name": "Facebook",
      "is_preferred": false,
      "parent_id": null,
      "created_at": "2023-09-19T22:34:56Z",
      "updated_at": "2023-09-19T22:34:56Z"
    }
  ],
  "categories": [
    {
      "id": 1041,
      "item_type": "Constituent",
      "name": "Acknowledgment Preference",
      "key": "ack_preferences",
      "facet_type": "single",
      "ordinal": 100,
      "removable": false,
      "editable": true,
      "display_format": "compact",
      "keywords": [
        {
          "id": 12221,
          "category_id": 1041,
          "name": "Prefers email",
          "description": null,
          "short_code": "ack_pref_email",
          "ordinal": 1,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-18T18:06:47Z",
          "updated_at": "2023-09-18T18:06:47Z"
        }
      ]
    },
    {
      "id": 1039,
      "item_type": "Constituent",
      "name": "Communication Tags",
      "key": "tags",
      "facet_type": "list",
      "ordinal": 100,
      "removable": true,
      "editable": true,
      "display_format": "compact",
      "keywords": [
        {
          "id": 12211,
          "category_id": 1039,
          "name": "Do not call",
          "description": null,
          "short_code": "do_not_call",
          "ordinal": 100,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-18T18:06:47Z",
          "updated_at": "2023-09-18T18:06:47Z"
        }
      ]
    },
    {
      "id": 1040,
      "item_type": "Constituent",
      "name": "Giving Status",
      "key": "giving_status",
      "facet_type": "list",
      "ordinal": 100,
      "removable": false,
      "editable": false,
      "display_format": "compact",
      "keywords": [
        {
          "id": 12216,
          "category_id": 1040,
          "name": "Active Donor",
          "description": null,
          "short_code": "active_donor",
          "ordinal": 2,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-18T18:06:47Z",
          "updated_at": "2023-09-18T18:06:47Z"
        }
      ]
    }
  ],
  "groups": [
    {
      "id": 595476,
      "constituent_id": 959480,
      "group_id": 3241,
      "group_name": "Board Member",
      "date_start": null,
      "date_end": null,
      "is_current": true,
      "created_at": "2023-09-19T22:24:37Z",
      "updated_at": "2023-09-19T22:24:37Z"
    }
  ],
  "memberships": [
    {
      "id": 424,
      "constituent_id": 959480,
      "membership_level_id": 388,
      "membership_level_name": "Gold",
      "date_start": "2022-09-18",
      "finish_date": "2023-09-18",
      "note": null,
      "created_at": "2023-09-18T18:25:01Z",
      "updated_at": "2023-12-01T17:12:16Z"
    }
  ],
  "custom_attrs": [
    {
      "id": 514928,
      "classification": "text",
      "name": "Background Info",
      "key": "background_info",
      "ordinal": 100,
      "value": ""
    },
    {
      "id": 514936,
      "classification": "integer",
      "name": "Test Number",
      "key": "test_number",
      "ordinal": 100,
      "value": ""
    }
  ]
}
                



PATCH /api/v1/constituents/{id} - Update constituent

Update the Constituent along with related objects

Parameter Name Description Type Required? Parameter Type
id Constituent Id integer true path
body Update Objects UpdateBody true body

UpdateBody

UpdateBody {
external_constituent_id ( integer , optional ): External constituent ID,
is_org ( boolean , optional ): This constituent is an organization or company,
constituent_contact_type_id ( integer , optional ): Constituent contact type ID,
constituent_contact_type_name ( string , optional ): Constituent contact type,
prefix ( string , optional ): Prefix,
first_name ( string , required ): First name,
middle_name ( string , optional ): Middle name,
last_name ( string , required ): Last name,
suffix ( string , optional ): Suffix,
spouse_name ( string , optional ): Spouse/Partner,
org_name ( string , optional ): Organization name,
job_title ( string , optional ): Job title,
addressee ( string , optional ): Addressee/Label name,
salutation ( string , optional ): Salutation,
is_deceased ( boolean , optional ): Deceased?,
deceased_date ( string , optional ): Deceased date,
annual_report_name ( string , optional ): Annual report name,
birthday ( date , optional ): Birthday,
gender ( string , optional ): Gender,
maiden_name ( string , optional ): Maiden name,
nick_name ( string , optional ): Nickname,
spouse_nick_name ( string , optional ): Spouse nickname,
date_added ( date , optional ): Date added,
alt_salutation ( string , optional ): Alt salutation,
alt_addressee ( string , optional ): Alt addressee,
honorary_name ( string , optional ): Honorary name,
assistant_name ( string , optional ): Assistant name,
marital_status_id ( integer , optional ): Marital status ID,
marital_status_name ( string , optional ): Marital status,
is_anon ( boolean , optional ): Gives anonymously?,
remove_previous_email_addresses ( boolean , optional ): Remove previous email addresses,
email_addresses ( array , required , EmailAddress ): Email Address Objects,
remove_previous_phone_numbers ( boolean , optional ): Remove previous phone numbers,
phone_numbers ( array , optional , PhoneNumber ): Phone Number Objects,
remove_previous_street_addresses ( boolean , optional ): Remove previous street addresses,
street_addresses ( array , optional , StreetAddress ): Street Address Objects,
remove_previous_web_addresses ( boolean , optional ): Remove previous web addresses,
web_addresses ( array , optional , WebAddress ): Web Address Objects,
categories ( array , optional , CategoryAggregatedUpdate ): Constituent Categories,
remove_previous_groups ( boolean , optional ): Remove previous groups,
groups ( array , optional , GroupMembershipUpdate ): Group Objects,
custom_attrs ( array , optional , CustomAttr_create ): Custom Attrubute Objects
}
EmailAddress {
address ( string , optional ): Email Address,
email_address_type_id ( integer , optional ): Email Address Type ID,
email_type_name ( string , optional ): Email Address Type Name,
is_preferred ( boolean , optional ): Make this the preferred email address,
not_current ( boolean , optional ): No longer a current email address
}
PhoneNumber {
number ( string , optional ): Phone Number,
phone_number_type_id ( integer , optional ): Phone Number Type Id,
phone_type_name ( string , optional ): Phone Number Type Name,
is_preferred ( boolean , optional ): Make this the preferred phone number,
not_current ( boolean , optional ): No longer a current phone number
}
StreetAddress {
street ( string , optional ): Street,
street_address_type_id ( integer , optional ): Street Address Type ID,
street_type_name ( string , optional ): Street Address Type Name,
city ( string , optional ): City,
state ( string , optional ): State/Province,
postal_code ( string , optional ): Zip/Postal Code,
county ( string , optional ): County,
country ( string , optional ): Country,
seasonal_from ( string , optional ): Seasonal from (mm-dd),
seasonal_to ( string , optional ): Seasonal to (mm-dd),
seasonal ( boolean , optional ): Is seasonal?,
is_preferred ( boolean , optional ): Is preferred address,
not_current ( boolean , optional ): Not current?
}
WebAddress {
url ( string , optional ): Web Address,
web_address_type_id ( integer , optional ): Web Address Type ID,
web_address_type_name ( string , optional ): Web Address Type Name,
is_preferred ( boolean , optional ): Make this the preferred email address
}
CategoryAggregatedUpdate {
id ( integer , optional ): Category Id,
name ( string , required ): Name,
key ( string , optional ): Key,
remove_previous_keywords ( boolean , optional ): Remove previous category keywords,
keywords ( array , required , KeywordAggregatedUpdate ): Keyword Values
}
KeywordAggregatedUpdate {
id ( integer , required ): Keyword Id,
name ( string , required ): Name,
short_code ( string , optional ): Short Code
}
GroupMembershipUpdate {
id ( integer , optional ): ID,
group_id ( integer , required ): Group Id,
group_name ( string , optional ): Group Name,
date_start ( date , optional ): Start Date,
date_end ( date , optional ): End Date,
is_current ( boolean , optional ): Current?
}
CustomAttr_create {
id ( integer , optional ): Custom Field Id,
key ( string , optional ): Key,
value ( string , required ): Value
}


Code Message Response
200 Ok
                  
{
  "api_version": 0,
  "id": 0,
  "external_constituent_id": 0,
  "is_org": true,
  "constituent_contact_type_id": 0,
  "constituent_contact_type_name": "",
  "prefix": "",
  "first_name": "",
  "middle_name": "",
  "last_name": "",
  "suffix": "",
  "spouse_name": "",
  "org_name": "",
  "job_title": "",
  "addressee": "",
  "salutation": "",
  "sort_name": "",
  "constituent_interest_level_id": 0,
  "constituent_interest_level_name": "",
  "constituent_rating_id": 0,
  "constituent_rating_name": "",
  "is_deceased": true,
  "deceased_date": "",
  "annual_report_name": "",
  "birthday": "",
  "gender": "",
  "maiden_name": "",
  "nick_name": "",
  "spouse_nick_name": "",
  "date_added": "",
  "alt_salutation": "",
  "alt_addressee": "",
  "honorary_name": "",
  "assistant_name": "",
  "marital_status_id": 0,
  "marital_status_name": "",
  "is_anon": true,
  "created_at": "",
  "updated_at": "",
  "email_addresses": [
    {
      "id": 0,
      "address": "",
      "email_address_type_id": 1,
      "email_type_name": "Home",
      "is_preferred": true,
      "not_current": true,
      "created_at": "",
      "updated_at": ""
    }
  ],
  "phone_numbers": [
    {
      "id": 0,
      "number": "",
      "phone_number_type_id": 1,
      "phone_type_name": "Home",
      "is_preferred": true,
      "not_current": true,
      "created_at": "",
      "updated_at": ""
    }
  ],
  "street_addresses": [
    {
      "id": 0,
      "street": "",
      "city": "",
      "state": "",
      "country": "",
      "postal_code": "",
      "county": "",
      "street_address_type_id": 1,
      "street_type_name": "Home",
      "is_preferred": true,
      "not_current": true,
      "seasonal_from": "01-01",
      "seasonal_to": "12-31",
      "seasonal": true,
      "lat": "",
      "lng": "",
      "zip5": "",
      "verified": true,
      "verified_on": "",
      "created_at": "",
      "updated_at": ""
    }
  ],
  "web_addresses": [
    {
      "id": 0,
      "url": "",
      "web_address_type_id": 0,
      "web_address_type_name": "",
      "is_preferred": true,
      "created_at": "",
      "updated_at": ""
    }
  ],
  "categories": [
    {
      "id": 0,
      "item_type": "Constituent",
      "name": "",
      "key": "",
      "facet_type": "",
      "ordinal": 0,
      "removable": true,
      "editable": true,
      "display_format": "",
      "keywords": [
        {
          "id": 0,
          "category_id": 0,
          "name": "",
          "description": "",
          "short_code": "",
          "ordinal": 0,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "",
          "updated_at": ""
        }
      ]
    }
  ],
  "groups": [
    {
      "id": 0,
      "constituent_id": 0,
      "group_id": 0,
      "group_name": "",
      "date_start": "",
      "date_end": "",
      "is_current": true,
      "created_at": "",
      "updated_at": ""
    }
  ],
  "memberships": [
    {
      "id": 0,
      "constituent_id": 0,
      "membership_level_id": 0,
      "membership_level_name": "",
      "date_start": "",
      "finish_date": "",
      "note": "",
      "created_at": "",
      "updated_at": ""
    }
  ],
  "custom_attrs": [
    {
      "id": 0,
      "classification": "",
      "name": "",
      "key": "",
      "ordinal": 0,
      "value": ""
    }
  ]
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959566

Body:
                  
{
  "is_org": false,
  "first_name": "Joe",
  "last_name": "Doe",
  "middle_name": "Moe",
  "street_addresses": [
    {
      "street": "123 SE Tree",
      "city": "Seattle",
      "state": "WA",
      "postal_code": "98101"
    }
  ]
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 959566,
  "external_constituent_id": "999",
  "is_org": false,
  "constituent_contact_type_id": 1243,
  "constituent_contact_type_name": "Primary",
  "prefix": null,
  "first_name": "Joe",
  "middle_name": "Moe",
  "last_name": "Doe",
  "suffix": null,
  "spouse_name": null,
  "org_name": null,
  "job_title": null,
  "addressee": "Joe Doe",
  "salutation": "Joe",
  "sort_name": "Doe, Joe",
  "constituent_interest_level_id": null,
  "constituent_interest_level_name": null,
  "constituent_rating_id": null,
  "constituent_rating_name": null,
  "is_deceased": false,
  "deceased_date": null,
  "annual_report_name": "Joe Doe",
  "birthday": null,
  "gender": null,
  "maiden_name": null,
  "nick_name": null,
  "spouse_nick_name": null,
  "date_added": "2024-02-06",
  "alt_salutation": "Joe",
  "alt_addressee": "Joe Doe",
  "honorary_name": "Joe Doe",
  "assistant_name": null,
  "marital_status_id": null,
  "marital_status_name": null,
  "is_anon": false,
  "created_at": "2024-02-06T15:58:12Z",
  "updated_at": "2024-02-06T15:58:13Z",
  "street_addresses": [
    {
      "id": 838510,
      "street": "123 SE Tree",
      "city": "Seattle",
      "state": "WA",
      "country": null,
      "postal_code": "98101",
      "county": null,
      "street_address_type_id": 1,
      "street_type_name": "Home",
      "is_preferred": true,
      "not_current": false,
      "parent_id": null,
      "seasonal_from": "01-01",
      "seasonal_to": "12-31",
      "seasonal": null,
      "lat": null,
      "lng": null,
      "zip5": "98101",
      "verified": false,
      "verified_on": null,
      "created_at": "2024-02-06T15:58:13Z",
      "updated_at": "2024-02-06T15:58:13Z"
    }
  ],
  "phone_numbers": [

  ],
  "email_addresses": [
    {
      "id": 276595,
      "address": "joed@example.com",
      "email_address_type_id": 1,
      "email_type_name": "Home",
      "is_preferred": true,
      "not_current": false,
      "parent_id": null,
      "created_at": "2024-02-06T15:58:12Z",
      "updated_at": "2024-02-06T15:58:12Z"
    }
  ],
  "web_addresses": [

  ],
  "categories": [
    {
      "id": 1039,
      "item_type": "Constituent",
      "name": "Communication Tags",
      "key": "tags",
      "facet_type": "list",
      "ordinal": 100,
      "removable": true,
      "editable": true,
      "display_format": "compact",
      "keywords": [
        {
          "id": 12225,
          "category_id": 1039,
          "name": "New Tag",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2023-09-18T20:48:13Z",
          "updated_at": "2023-09-18T20:48:13Z"
        }
      ]
    }
  ],
  "groups": [
    {
      "id": 595500,
      "constituent_id": 959566,
      "group_id": 3241,
      "group_name": "Board Member",
      "date_start": null,
      "date_end": null,
      "is_current": true,
      "created_at": "2024-02-06T15:58:12Z",
      "updated_at": "2024-02-06T15:58:12Z"
    }
  ],
  "memberships": [

  ],
  "custom_attrs": [
    {
      "id": 514928,
      "classification": "text",
      "name": "Background Info",
      "key": "background_info",
      "ordinal": 100,
      "value": "Founding member"
    }
  ]
}
                



DELETE /api/v1/constituents/{id} - Delete constituent

Delete the Constituent along with related objects.

Parameter Name Description Type Required? Parameter Type
id Constituent Id integer true path


Code Message Response
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959566

Response:
                  
{
  "api_version": "1.0",
  "result": "success"
}
                



Contact Reports Management

GET /api/v1/constituents/{constituent_id}/contact_reports - Fetch Contact Reports for Constituent

Lists all the contact reports for a constituent.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "constituent_id": 0,
      "name": "",
      "contact_report_type_id": 0,
      "contact_report_type_name": "",
      "original_date": "",
      "text": "",
      "team_member": "",
      "team_member_email": "",
      "created_at": "",
      "updated_at": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/contact_reports

Response:
                  
{
  "api_version": "1.0",
  "items_count": 1,
  "total_items": 1,
  "limit": 25,
  "offset": 0,
  "item_type": "contact_report",
  "items": [
    {
      "id": 9881,
      "constituent_id": 959480,
      "name": "Contact report for 'Appleton, Larry'",
      "contact_report_type_id": 2183,
      "contact_report_type_name": "Call",
      "original_date": "2023-09-18",
      "text": "Reached out to Larry regarding upcoming pledge drive.",
      "team_member": "Nick Bicknell",
      "team_member_email": "team_member@example.com",
      "created_at": "2023-09-18T21:49:19Z",
      "updated_at": "2023-09-18T22:05:56Z"
    }
  ]
}
                



POST /api/v1/constituents/{constituent_id}/contact_reports - Create new Contact Report

Add contact report.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
body Create Objects CreateBody true body

CreateBody

CreateBody {
name ( string , optional ): Name,
contact_report_type_id ( integer , optional ): Contact Report Type Id,
contact_report_type_name ( string , optional ): Contact Report Type Name,
original_date ( date , optional ): Original Date,
text ( string , required ): Text,
team_member ( string , optional ): Team Member ('id', 'email', or 'first_name last_name')
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "name": "",
  "contact_report_type_id": 0,
  "contact_report_type_name": "",
  "original_date": "",
  "text": "",
  "team_member": "",
  "team_member_email": "",
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/contact_reports

Body:
                  
{
  "name": "New Contact Report",
  "contact_report_type_name": "Call",
  "original_date": "2018-06-05",
  "text": "Follow up contact.",
  "team_member": "nick@littlegreenlight.com"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 9920,
  "constituent_id": 959480,
  "name": "New Contact Report",
  "contact_report_type_id": 2183,
  "contact_report_type_name": "Call",
  "original_date": "2018-06-05",
  "text": "Follow up contact.",
  "team_member": "Nick Bicknell",
  "team_member_email": "team_member@example.com",
  "created_at": "2024-02-06T15:58:14Z",
  "updated_at": "2024-02-06T15:58:14Z"
}
                



GET /api/v1/contact_reports/search - Search for Contact Reports

Search for active contact reports

Parameter Name Description Type Required? Parameter Type
q[] Query String. (EX: updated_from=2016-01-01) string true query
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "constituent_id": 0,
      "name": "",
      "contact_report_type_id": 0,
      "contact_report_type_name": "",
      "original_date": "",
      "text": "",
      "team_member": "",
      "team_member_email": "",
      "created_at": "",
      "updated_at": ""
    }
  ]
}
                
400 Bad Request
401 Unauthorized
403 Forbidden

Available Search Terms:

Original Date original_date_from Date updated from (YYYY-MM-DDTHH:MM:SSZ)
original_date_to Date updated to (YYYY-MM-DDTHH:MM:SSZ)
Name name Name contains string
Text text Text contains string
Contact Report Type contact_report_type_id Comma separated contact_report_type_ids
Constituent Id constituent_id Comma separated constituent_ids
Constituent Keyword const_keyword Comma separated Constituent keyword_ids
Updated At updated_from Date updated from (YYYY-MM-DDTHH:MM:SSZ)
updated_to Date updated to (YYYY-MM-DDTHH:MM:SSZ)

Note: Multiple terms may be combined using a semi-colon: "updated_from=2018-05-04;updated_to=2018-05-04"

Example - Search by Name:

URI: https://api.littlegreenlight.com/api/v1/contact_reports/search

Query:
q[]=name=Dinner&limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 1,
  "total_items": 1,
  "limit": 5,
  "offset": 0,
  "item_type": "contact_report",
  "items": [
    {
      "id": 9884,
      "constituent_id": 959519,
      "name": "Dinner with Jerry",
      "contact_report_type_id": 2185,
      "contact_report_type_name": "Meeting",
      "original_date": "2023-09-18",
      "text": "The details of the dinner in here.",
      "team_member": "Nick Bicknell",
      "team_member_email": "team_member@example.com",
      "created_at": "2023-09-18T22:01:22Z",
      "updated_at": "2023-09-18T22:05:03Z"
    }
  ]
}
                

Example - Search by Constituent Keyword and Updated Since:

URI: https://api.littlegreenlight.com/api/v1/contact_reports/search

Query:
q[]=const_keyword=12221;updated_from=2016-01-01&limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 2,
  "total_items": 2,
  "limit": 5,
  "offset": 0,
  "item_type": "contact_report",
  "items": [
    {
      "id": 9881,
      "constituent_id": 959480,
      "name": "Contact report for 'Appleton, Larry'",
      "contact_report_type_id": 2183,
      "contact_report_type_name": "Call",
      "original_date": "2023-09-18",
      "text": "Reached out to Larry regarding upcoming pledge drive.",
      "team_member": "Nick Bicknell",
      "team_member_email": "team_member@example.com",
      "created_at": "2023-09-18T21:49:19Z",
      "updated_at": "2023-09-18T22:05:56Z"
    },
    {
      "id": 9920,
      "constituent_id": 959480,
      "name": "New Contact Report",
      "contact_report_type_id": 2183,
      "contact_report_type_name": "Call",
      "original_date": "2018-06-05",
      "text": "Follow up contact.",
      "team_member": "Nick Bicknell",
      "team_member_email": "team_member@example.com",
      "created_at": "2024-02-06T15:58:14Z",
      "updated_at": "2024-02-06T15:58:14Z"
    }
  ]
}
                



GET /api/v1/contact_reports - Fetch Contact Reports for Account

Lists all the contact reports for an account.

Parameter Name Description Type Required? Parameter Type
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "constituent_id": 0,
      "name": "",
      "contact_report_type_id": 0,
      "contact_report_type_name": "",
      "original_date": "",
      "text": "",
      "team_member": "",
      "team_member_email": "",
      "created_at": "",
      "updated_at": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/contact_reports

Response:
                  
{
  "api_version": "1.0",
  "items_count": 3,
  "total_items": 3,
  "limit": 25,
  "offset": 0,
  "item_type": "contact_report",
  "items": [
    {
      "id": 9881,
      "constituent_id": 959480,
      "name": "Contact report for 'Appleton, Larry'",
      "contact_report_type_id": 2183,
      "contact_report_type_name": "Call",
      "original_date": "2023-09-18",
      "text": "Reached out to Larry regarding upcoming pledge drive.",
      "team_member": "Nick Bicknell",
      "team_member_email": "team_member@example.com",
      "created_at": "2023-09-18T21:49:19Z",
      "updated_at": "2023-09-18T22:05:56Z"
    },
    {
      "id": 9884,
      "constituent_id": 959519,
      "name": "Dinner with Jerry",
      "contact_report_type_id": 2185,
      "contact_report_type_name": "Meeting",
      "original_date": "2023-09-18",
      "text": "The details of the dinner in here.",
      "team_member": "Nick Bicknell",
      "team_member_email": "team_member@example.com",
      "created_at": "2023-09-18T22:01:22Z",
      "updated_at": "2023-09-18T22:05:03Z"
    },
    {
      "id": 9920,
      "constituent_id": 959480,
      "name": "New Contact Report",
      "contact_report_type_id": 2183,
      "contact_report_type_name": "Call",
      "original_date": "2018-06-05",
      "text": "Follow up contact.",
      "team_member": "Nick Bicknell",
      "team_member_email": "team_member@example.com",
      "created_at": "2024-02-06T15:58:14Z",
      "updated_at": "2024-02-06T15:58:14Z"
    }
  ]
}
                



GET /api/v1/contact_reports/{id} - Show Contact Report details

Show details for the contact report.

Parameter Name Description Type Required? Parameter Type
id Contact Report Id integer true path


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "name": "",
  "contact_report_type_id": 0,
  "contact_report_type_name": "",
  "original_date": "",
  "text": "",
  "team_member": "",
  "team_member_email": "",
  "created_at": "",
  "updated_at": ""
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/contact_reports/9920

Response:
                  
{
  "api_version": "1.0",
  "id": 9920,
  "constituent_id": 959480,
  "name": "New Contact Report",
  "contact_report_type_id": 2183,
  "contact_report_type_name": "Call",
  "original_date": "2018-06-05",
  "text": "Follow up contact.",
  "team_member": "Nick Bicknell",
  "team_member_email": "team_member@example.com",
  "created_at": "2024-02-06T15:58:14Z",
  "updated_at": "2024-02-06T15:58:14Z"
}
                



PATCH /api/v1/contact_reports/{id} - Update Contact Report

Update the contact report.

Parameter Name Description Type Required? Parameter Type
id Contact Report Id integer true path
body Update Objects UpdateBody true body

UpdateBody

UpdateBody {
constituent_id ( integer , optional ): Constituent Id,
name ( string , optional ): Name,
contact_report_type_id ( integer , optional ): Contact Report Type Id,
contact_report_type_name ( string , optional ): Contact Report Type Name,
original_date ( date , optional ): Original Date,
text ( string , required ): Text,
team_member ( string , optional ): Team Member ('id', 'email', or 'first_name last_name')
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "name": "",
  "contact_report_type_id": 0,
  "contact_report_type_name": "",
  "original_date": "",
  "text": "",
  "team_member": "",
  "team_member_email": "",
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/contact_reports/9920

Body:
                  
{
  "contact_report_type_name": "Email"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 9920,
  "constituent_id": 959480,
  "name": "New Contact Report",
  "contact_report_type_id": 2184,
  "contact_report_type_name": "Email",
  "original_date": "2018-06-05",
  "text": "Follow up contact.",
  "team_member": "Nick Bicknell",
  "team_member_email": "team_member@example.com",
  "created_at": "2024-02-06T15:58:14Z",
  "updated_at": "2024-02-06T15:58:15Z"
}
                



DELETE /api/v1/contact_reports/{id} - Delete Contact Report

Delete the contact report.

Parameter Name Description Type Required? Parameter Type
id Contact Report Id integer true path


Code Message Response
200 Ok
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/contact_reports/9920

Response:
                  
{
  "api_version": "1.0",
  "result": "success"
}
                



Custom Attributes Management

GET /api/v1/attributes - Fetch Custom Attributes

Lists custom attributes..

Parameter Name Description Type Required? Parameter Type
item_type Attributes for type (default: Constituent). Available: Constituent, Invitation string query
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "item_type": 0,
      "name": "",
      "description": "",
      "key": "",
      "min_val": 0,
      "max_val": 0
    }
  ]
}
                
401 Unauthorized
403 Forbidden



Email Address Management

GET /api/v1/constituents/{constituent_id}/email_addresses - Fetch Email Addresses

Lists all the email addresses.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "item_id": 0,
      "item_type": "",
      "address": "",
      "email_address_type_id": 1,
      "email_type_name": "Home",
      "is_preferred": true,
      "not_current": true,
      "created_at": "",
      "updated_at": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/email_addresses

Response:
                  
{
  "api_version": "1.0",
  "items_count": 1,
  "total_items": 1,
  "limit": 25,
  "offset": 0,
  "item_type": "email_address",
  "items": [
    {
      "id": 276464,
      "item_id": 959480,
      "item_type": "Constituent",
      "address": "appleton@perfectstrangers.com",
      "email_address_type_id": 1,
      "email_type_name": "Home",
      "is_preferred": true,
      "not_current": false,
      "parent_id": null,
      "created_at": "2023-09-18T18:25:01Z",
      "updated_at": "2023-09-19T22:34:56Z"
    }
  ]
}
                



POST /api/v1/constituents/{constituent_id}/email_addresses - Create new Email Address

Add email address.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
body Create Objects CreateBody true body

CreateBody

CreateBody {
address ( string , optional ): Email Address,
email_address_type_id ( integer , optional ): Email Address Type ID,
email_type_name ( string , optional ): Email Address Type Name,
is_preferred ( boolean , optional ): Make this the preferred email address,
not_current ( boolean , optional ): No longer a current email address
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "item_id": 0,
  "item_type": "",
  "address": "",
  "email_address_type_id": 1,
  "email_type_name": "Home",
  "is_preferred": true,
  "not_current": true,
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/email_addresses

Body:
                  
{
  "address": "test@example.com"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 276596,
  "item_id": 959480,
  "item_type": "Constituent",
  "address": "test@example.com",
  "email_address_type_id": 1,
  "email_type_name": "Home",
  "is_preferred": false,
  "not_current": false,
  "parent_id": null,
  "created_at": "2024-02-06T15:58:16Z",
  "updated_at": "2024-02-06T15:58:16Z"
}
                



GET /api/v1/email_addresses/{id} - Show Email Address details

Show details for the email address.

Parameter Name Description Type Required? Parameter Type
id Email Address Id integer true path


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "item_id": 0,
  "item_type": "",
  "address": "",
  "email_address_type_id": 1,
  "email_type_name": "Home",
  "is_preferred": true,
  "not_current": true,
  "created_at": "",
  "updated_at": ""
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/email_addresses/276464

Response:
                  
{
  "api_version": "1.0",
  "id": 276464,
  "item_id": 959480,
  "item_type": "Constituent",
  "address": "appleton@perfectstrangers.com",
  "email_address_type_id": 1,
  "email_type_name": "Home",
  "is_preferred": true,
  "not_current": false,
  "parent_id": null,
  "created_at": "2023-09-18T18:25:01Z",
  "updated_at": "2023-09-19T22:34:56Z"
}
                



PATCH /api/v1/email_addresses/{id} - Update Email Address

Update the email address.

Parameter Name Description Type Required? Parameter Type
id Email Address Id integer true path
body Update Objects UpdateBody true body

UpdateBody

UpdateBody {
address ( string , optional ): Email Address,
email_address_type_id ( integer , optional ): Email Address Type ID,
email_type_name ( string , optional ): Email Address Type Name,
is_preferred ( boolean , optional ): Make this the preferred email address,
not_current ( boolean , optional ): No longer a current email address
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "item_id": 0,
  "item_type": "",
  "address": "",
  "email_address_type_id": 1,
  "email_type_name": "Home",
  "is_preferred": true,
  "not_current": true,
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/email_addresses/276596

Body:
                  
{
  "email_address_type_id": 2
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 276596,
  "item_id": 959480,
  "item_type": "Constituent",
  "address": "test@example.com",
  "email_address_type_id": 2,
  "email_type_name": "Work",
  "is_preferred": false,
  "not_current": false,
  "parent_id": null,
  "created_at": "2024-02-06T15:58:16Z",
  "updated_at": "2024-02-06T15:58:16Z"
}
                



DELETE /api/v1/email_addresses/{id} - Delete Email Address

Delete the email address.

Parameter Name Description Type Required? Parameter Type
id Email Address Id integer true path


Code Message Response
200 Ok
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/email_addresses/276596

Response:
                  
{
  "api_version": "1.0",
  "result": "success"
}
                



Events Management

GET /api/v1/events - Fetch Events

Lists all the events.

Parameter Name Description Type Required? Parameter Type
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "name": "",
      "description": "",
      "date": "",
      "end_date": "",
      "financial_goal": 0,
      "projected_amount": 0,
      "code": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/events

Query:
limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 3,
  "total_items": 3,
  "limit": 5,
  "offset": 0,
  "item_type": "event",
  "items": [
    {
      "id": 1068,
      "name": "Fancy Lunch (sample)",
      "description": null,
      "date": "2023-09-11",
      "end_date": null,
      "financial_goal": null,
      "projected_amount": null,
      "code": null
    },
    {
      "id": 1069,
      "name": "Winter 2020 Fundraising Gala",
      "description": "",
      "date": "2021-07-01",
      "end_date": null,
      "financial_goal": null,
      "projected_amount": null,
      "code": ""
    },
    {
      "id": 1070,
      "name": "Board weekend",
      "description": "",
      "date": "2023-11-03",
      "end_date": "2023-11-05",
      "financial_goal": null,
      "projected_amount": null,
      "code": ""
    }
  ]
}
                



Funds Management

GET /api/v1/funds - Fetch Funds

Lists all the funds.

Parameter Name Description Type Required? Parameter Type
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "name": "",
      "description": "",
      "code": 0,
      "start_date": "",
      "end_date": "",
      "financial_goal": 0
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/funds

Query:
limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 4,
  "total_items": 4,
  "limit": 5,
  "offset": 0,
  "item_type": "fund",
  "items": [
    {
      "id": 2395,
      "name": "Unrestricted (sample)",
      "description": null,
      "code": null,
      "start_date": null,
      "end_date": null,
      "financial_goal": null
    },
    {
      "id": 2396,
      "name": "New Building (sample)",
      "description": null,
      "code": null,
      "start_date": null,
      "end_date": null,
      "financial_goal": null
    },
    {
      "id": 2397,
      "name": "Memorial Fund (sample)",
      "description": null,
      "code": null,
      "start_date": null,
      "end_date": null,
      "financial_goal": null
    },
    {
      "id": 2398,
      "name": "General",
      "description": null,
      "code": null,
      "start_date": null,
      "end_date": null,
      "financial_goal": null
    }
  ]
}
                



Gift Category Management

GET /api/v1/gift_categories - Fetch Gift Categories

Lists all the gift categories.

Parameter Name Description Type Required? Parameter Type
gift_type_id Gift type ID string query
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "display_name": "",
      "gift_type_id": 0,
      "gift_type_name": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/gift_categories

Query:
limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 5,
  "total_items": 14,
  "limit": 5,
  "offset": 0,
  "next_item": 5,
  "next_link": "https://api.littlegreenlight.com/api/v1/gift_categories?limit=5&offset=5",
  "item_type": "gift_category",
  "items": [
    {
      "id": 5937,
      "display_name": "Donation",
      "gift_type_id": 1,
      "gift_type_name": "Gift"
    },
    {
      "id": 5938,
      "display_name": "Matching Gift",
      "gift_type_id": 1,
      "gift_type_name": "Gift"
    },
    {
      "id": 5939,
      "display_name": "Pledge Payment",
      "gift_type_id": 1,
      "gift_type_name": "Gift"
    },
    {
      "id": 5940,
      "display_name": "Standard Pledge",
      "gift_type_id": 7,
      "gift_type_name": "Pledge"
    },
    {
      "id": 5941,
      "display_name": "Grant",
      "gift_type_id": 7,
      "gift_type_name": "Pledge"
    }
  ]
}
                



Gift Type Management

GET /api/v1/gift_types - Fetch Gift Types

Lists all the gift types.

Parameter Name Description Type Required? Parameter Type
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "name": "",
      "ordinal": 0
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/gift_types

Query:
limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 5,
  "total_items": 10,
  "limit": 5,
  "offset": 0,
  "next_item": 5,
  "next_link": "https://api.littlegreenlight.com/api/v1/gift_types?limit=5&offset=5",
  "item_type": "gift_type",
  "items": [
    {
      "id": 1,
      "name": "Gift",
      "ordinal": 1
    },
    {
      "id": 5,
      "name": "Other Income",
      "ordinal": 3
    },
    {
      "id": 7,
      "name": "Pledge",
      "ordinal": 4
    },
    {
      "id": 8,
      "name": "In Kind",
      "ordinal": 2
    },
    {
      "id": 9,
      "name": "Soft Credit",
      "ordinal": 6
    }
  ]
}
                



Gifts Management

GET /api/v1/constituents/{constituent_id}/gifts - Fetch Gifts

Lists all the gifts.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "constituent_id": 0,
      "external_id": 0,
      "is_anon": true,
      "gift_type_id": 0,
      "gift_type_name": "",
      "gift_category_id": 0,
      "gift_category_name": "",
      "campaign_id": 0,
      "campaign_name": "",
      "fund_id": 0,
      "fund_name": "",
      "appeal_id": 0,
      "appeal_name": "",
      "event_id": 0,
      "event_name": "",
      "received_amount": 0,
      "received_date": "",
      "payment_type_id": 0,
      "payment_type_name": "",
      "check_number": "",
      "deductible_amount": 0,
      "note": "",
      "ack_template_name": "",
      "deposit_date": "",
      "deposited_amount": 0,
      "parent_gift_id": 0,
      "parent_external_id": 0,
      "tribute_name": "",
      "tributee_name": "",
      "tribute_dedication": "",
      "tribute_recipient_name": "",
      "tribute_recipient_salutation": "",
      "tribute_recipient_email": "",
      "tribute_recipient_address": "",
      "tribute_recipient_notification_template": "",
      "team_member_email": "",
      "custom_fields": [
        {
          "id": 0,
          "item_type": "",
          "name": "",
          "key": "",
          "facet_type": "",
          "ordinal": 0,
          "removable": true,
          "editable": true,
          "values": [
            {
              "category_id": 0,
              "name": "",
              "description": "",
              "short_code": "",
              "ordinal": 0,
              "removable": true,
              "can_change": true,
              "can_select": true
            }
          ]
        }
      ]
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/gifts

Response:
                  
{
  "api_version": "1.0",
  "items_count": 4,
  "total_items": 4,
  "limit": 25,
  "offset": 0,
  "item_type": "gift",
  "items": [
    {
      "id": 894485,
      "constituent_id": 959480,
      "gift_type_id": 1,
      "gift_type_name": "Gift",
      "amount": 250.0,
      "date": "2023-03-18",
      "created_at": "2023-09-18T18:25:01Z",
      "updated_at": "2023-09-18T18:25:01Z"
    },
    {
      "id": 894486,
      "constituent_id": 959480,
      "gift_type_id": 1,
      "gift_type_name": "Gift",
      "amount": 100.0,
      "date": "2021-02-18",
      "created_at": "2023-09-18T18:25:01Z",
      "updated_at": "2023-09-18T18:25:01Z"
    },
    {
      "id": 894487,
      "constituent_id": 959480,
      "gift_type_id": 1,
      "gift_type_name": "Gift",
      "amount": 200.0,
      "date": "2020-03-18",
      "created_at": "2023-09-18T18:25:02Z",
      "updated_at": "2023-09-18T18:25:02Z"
    },
    {
      "id": 894488,
      "constituent_id": 959480,
      "gift_type_id": 1,
      "gift_type_name": "Gift",
      "amount": 50.0,
      "date": "2019-08-18",
      "created_at": "2023-09-18T18:25:02Z",
      "updated_at": "2023-09-18T18:25:02Z"
    }
  ]
}
                



POST /api/v1/constituents/{constituent_id}/gifts - Create new Gift

Add gift.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
body Create Objects CreateBody true body

CreateBody

CreateBody {
external_id ( integer , optional ): External Gift ID,
is_anon ( boolean , optional ): Gift is Anonymous?,
gift_type_id ( integer , required ): Gift type ID,
gift_type_name ( string , required ): Gift type name,
gift_category_id ( integer , optional ): Gift category ID,
gift_category_name ( string , optional ): Gift category name,
campaign_id ( integer , optional ): Campaign ID,
campaign_name ( string , optional ): Campaign name,
fund_id ( integer , optional ): Fund ID,
fund_name ( string , optional ): Fund name,
appeal_id ( integer , optional ): Appeal ID,
appeal_name ( string , optional ): Appeal name,
event_id ( integer , optional ): Event ID,
event_name ( string , optional ): Event name,
received_amount ( double , optional ): Gift amount,
received_date ( date , optional ): Gift date,
payment_type_id ( integer , optional ): Payment type ID,
payment_type_name ( string , optional ): Payment type name,
check_number ( string , optional ): Check/Reference No.,
deductible_amount ( double , optional ): Tax deductible amount,
note ( string , optional ): Gift note,
ack_template_name ( string , optional ): Ack. mailing template name. (use 'do_not_ack' to indicate no acknowledgment),
deposit_date ( date , optional ): Deposit Date,
deposited_amount ( double , optional ): Deposit Amount,
parent_gift_id ( integer , optional ): LGL parent gift ID,
parent_external_id ( integer , optional ): External parent gift ID,
tribute_name ( string , optional ): The name of tribute. Values: "Honorary - General", "Memorial - General", or a pre-defined named tribute,
tributee_name ( string , optional ): The name of the honoree/deceased,
tribute_dedication ( string , optional ): The tribute dedication note/text for a gift,
tribute_recipient_name ( string , optional ): The name of person who should be notified about this tribute gift.,
tribute_recipient_salutation ( string , optional ): The name of person who should be notified about this tribute gift.,
tribute_recipient_email ( string , optional ): The email of the person who should be notified about this tribute gift.,
tribute_recipient_address ( string , optional ): The address of the person who should be notified about this tribute gift.,
tribute_recipient_notification_template ( string , optional ): The notification template to be used for the person who should be notified about this tribute gift.,
team_member ( string , optional ): Team Member ('id', 'email', or 'first_name last_name'),
custom_fields ( array , optional , CustomFieldAggregatedUpdate ): Gift custom fields (Categories)
}
CustomFieldAggregatedUpdate {
id ( integer , optional ): Custom Field Id,
name ( string , required ): Name,
key ( string , optional ): Key,
remove_previous_values ( boolean , optional ): Remove previous field values,
values ( array , required , CustomValueAggregatedUpdate ): Values
}
CustomValueAggregatedUpdate {
id ( integer , required ): Value Id,
name ( string , required ): Name
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "external_id": 0,
  "is_anon": true,
  "gift_type_id": 0,
  "gift_type_name": "",
  "gift_category_id": 0,
  "gift_category_name": "",
  "campaign_id": 0,
  "campaign_name": "",
  "fund_id": 0,
  "fund_name": "",
  "appeal_id": 0,
  "appeal_name": "",
  "event_id": 0,
  "event_name": "",
  "received_amount": 0,
  "received_date": "",
  "payment_type_id": 0,
  "payment_type_name": "",
  "check_number": "",
  "deductible_amount": 0,
  "note": "",
  "ack_template_name": "",
  "deposit_date": "",
  "deposited_amount": 0,
  "parent_gift_id": 0,
  "parent_external_id": 0,
  "tribute_name": "",
  "tributee_name": "",
  "tribute_dedication": "",
  "tribute_recipient_name": "",
  "tribute_recipient_salutation": "",
  "tribute_recipient_email": "",
  "tribute_recipient_address": "",
  "tribute_recipient_notification_template": "",
  "team_member_email": "",
  "custom_fields": [
    {
      "id": 0,
      "item_type": "",
      "name": "",
      "key": "",
      "facet_type": "",
      "ordinal": 0,
      "removable": true,
      "editable": true,
      "values": [
        {
          "category_id": 0,
          "name": "",
          "description": "",
          "short_code": "",
          "ordinal": 0,
          "removable": true,
          "can_change": true,
          "can_select": true
        }
      ]
    }
  ]
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example - Create Gift with Custom Field:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/gifts

Body:
                  
{
  "gift_type_name": "Gift",
  "gift_category_name": "Donation",
  "campaign_name": "Annual Giving",
  "fund_name": "General",
  "appeal_name": "Annual Appeal 2020",
  "received_amount": 100,
  "received_date": "2021-07-01",
  "payment_type_name": "Credit Card",
  "deductible_amount": 100,
  "note": "See other note",
  "ack_template_name": "Donation Acknowledgment",
  "deposit_date": "2021-07-01",
  "deposited_amount": 100,
  "team_member": "1047042",
  "custom_fields": [
    {
      "name": "Test Gift Field #2",
      "values": [
        {
          "name": "v1"
        }
      ]
    }
  ]
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 894752,
  "constituent_id": 959480,
  "external_id": null,
  "is_anon": false,
  "gift_type_id": 1,
  "gift_type_name": "Gift",
  "gift_category_id": 5937,
  "gift_category_name": "Donation",
  "campaign_id": 822,
  "campaign_name": "Annual Giving",
  "fund_id": 2398,
  "fund_name": "General",
  "appeal_id": 2663,
  "appeal_name": "Annual Appeal 2020",
  "event_id": 0,
  "event_name": null,
  "received_amount": 100.0,
  "received_date": "2021-07-01",
  "payment_type_id": 1509,
  "payment_type_name": "Credit Card",
  "check_number": null,
  "deductible_amount": 100.0,
  "note": "See other note",
  "ack_template_name": "Donation Acknowledgment",
  "deposit_date": "2021-07-01",
  "deposited_amount": 100.0,
  "parent_gift_id": null,
  "parent_external_id": null,
  "tribute_name": null,
  "tributee_name": null,
  "tribute_dedication": null,
  "tribute_recipient_name": null,
  "tribute_recipient_salutation": null,
  "tribute_recipient_email": null,
  "tribute_recipient_address": null,
  "tribute_recipient_notification_template": null,
  "team_member": "Nick Bicknell",
  "team_member_email": "team_member@example.com",
  "custom_fields": [
    {
      "id": 1056,
      "item_type": "Gift",
      "name": "Test Gift Field #2",
      "key": "e0c9cb38_48e9_4515_abde_72a6d93722e6",
      "facet_type": "list",
      "ordinal": 100,
      "removable": true,
      "editable": true,
      "values": [
        {
          "id": 12252,
          "category_id": 1056,
          "name": "v1",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true
        }
      ]
    }
  ],
  "created_at": "2024-02-06T15:58:18Z",
  "updated_at": "2024-02-06T15:58:18Z"
}
                

Example - Create Gift with Tribute:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/gifts

Body:
                  
{
  "gift_type_name": "Gift",
  "gift_category_name": "Donation",
  "received_amount": 101,
  "received_date": "2021-07-02",
  "ack_template_name": "Donation Acknowledgment",
  "team_member": "1047042",
  "tribute_name": "Honorary - General",
  "tributee_name": "Mr. Rogers",
  "tribute_dedication": "Yes. I'll be your neighbor.",
  "tribute_recipient_name": "Ron Howard",
  "tribute_recipient_salutation": "Ron",
  "tribute_recipient_email": "rh@example.com",
  "tribute_recipient_notification_template": "Honorary Notification"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 894753,
  "constituent_id": 959480,
  "external_id": null,
  "is_anon": false,
  "gift_type_id": 1,
  "gift_type_name": "Gift",
  "gift_category_id": 5937,
  "gift_category_name": "Donation",
  "campaign_id": 0,
  "campaign_name": null,
  "fund_id": 0,
  "fund_name": null,
  "appeal_id": 0,
  "appeal_name": null,
  "event_id": 0,
  "event_name": null,
  "received_amount": 101.0,
  "received_date": "2021-07-02",
  "payment_type_id": null,
  "payment_type_name": null,
  "check_number": null,
  "deductible_amount": 0.0,
  "note": null,
  "ack_template_name": "Donation Acknowledgment",
  "deposit_date": "2021-07-02",
  "deposited_amount": 101.0,
  "parent_gift_id": null,
  "parent_external_id": null,
  "tribute_name": "Honorary - General",
  "tributee_name": "Mr. Rogers",
  "tribute_dedication": "Yes. I'll be your neighbor.",
  "tribute_recipient_name": "Ron Howard",
  "tribute_recipient_salutation": "Ron",
  "tribute_recipient_email": "rh@example.com",
  "tribute_recipient_address": null,
  "tribute_recipient_notification_template": "Honorary Notification",
  "team_member": "Nick Bicknell",
  "team_member_email": "team_member@example.com",
  "custom_fields": [

  ],
  "created_at": "2024-02-06T15:58:19Z",
  "updated_at": "2024-02-06T15:58:19Z"
}
                



GET /api/v1/gifts/search - Search for Gifts

Search for active gifts

Parameter Name Description Type Required? Parameter Type
q[] Query String. (EX: updated_from=2016-01-01) string true query
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "constituent_id": 0,
      "external_id": 0,
      "is_anon": true,
      "gift_type_id": 0,
      "gift_type_name": "",
      "gift_category_id": 0,
      "gift_category_name": "",
      "campaign_id": 0,
      "campaign_name": "",
      "fund_id": 0,
      "fund_name": "",
      "appeal_id": 0,
      "appeal_name": "",
      "event_id": 0,
      "event_name": "",
      "received_amount": 0,
      "received_date": "",
      "payment_type_id": 0,
      "payment_type_name": "",
      "check_number": "",
      "deductible_amount": 0,
      "note": "",
      "ack_template_name": "",
      "deposit_date": "",
      "deposited_amount": 0,
      "parent_gift_id": 0,
      "parent_external_id": 0,
      "tribute_name": "",
      "tributee_name": "",
      "tribute_dedication": "",
      "tribute_recipient_name": "",
      "tribute_recipient_salutation": "",
      "tribute_recipient_email": "",
      "tribute_recipient_address": "",
      "tribute_recipient_notification_template": "",
      "team_member_email": "",
      "custom_fields": [
        {
          "id": 0,
          "item_type": "",
          "name": "",
          "key": "",
          "facet_type": "",
          "ordinal": 0,
          "removable": true,
          "editable": true,
          "values": [
            {
              "category_id": 0,
              "name": "",
              "description": "",
              "short_code": "",
              "ordinal": 0,
              "removable": true,
              "can_change": true,
              "can_select": true
            }
          ]
        }
      ]
    }
  ]
}
                
400 Bad Request
401 Unauthorized
403 Forbidden

Available Search Terms:

Gift Date date_from "YYYY-MM-DD"
date_to "YYYY-MM-DD"
Gift Types gift_types "op|comma sep type IDs"
operators: in,ni
Amount gift_amount "op|number[|number2]"
operators: gte,lte,btw,gt,lt,eq,ne
Payment Types payment_types "op|comma sep type IDs"
operators: in,ni,bl
Campaigns campaigns "op|comma sep campaign IDs"
operators: in,ni,bl
Funds funds "op|comma sep fund IDs"
operators: in,ni,bl
Appeals appeals "op|comma sep appeal IDs"
operators: in,ni,bl
Appeal Type appeal_types "op|comma sep type IDs"
operators: in,ni
Events events "op|comma sep event IDs"
operators: in,ni,bl
Event Type event_types "op|comma sep type IDs"
operators: in,ni
Gift Categories categories "op|comma sep cat IDs"
operators: in,ni,bl
Gift IDs gift_ids "comma sep gift IDs"
External Gift IDs external_gift_ids "comma sep ext gift IDs"
Creation Date created_from Date created from (YYYY-MM-DDTHH:MM:SSZ)
created_to Date created to (YYYY-MM-DDTHH:MM:SSZ)
Updated Date updated_from Date updated from (YYYY-MM-DDTHH:MM:SSZ)
updated_to Date updated to (YYYY-MM-DDTHH:MM:SSZ)

Note: Multiple terms may be combined using a semi-colon: "updated_from=2018-05-04;updated_to=2018-05-04"

Example - Search by Between Amounts:

URI: https://api.littlegreenlight.com/api/v1/gifts/search

Query:
q[]=gift_amount=btw|100|1000&limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 5,
  "total_items": 232,
  "limit": 5,
  "offset": 0,
  "next_item": 5,
  "next_link": "https://api.littlegreenlight.com/api/v1/gifts/search?limit=5&offset=5&q%5B%5D=gift_amount%3Dbtw%7C100%7C1000",
  "item_type": "gift",
  "items": [
    {
      "id": 894311,
      "constituent_id": 959438,
      "external_id": "lgl_sample_data-12",
      "is_anon": false,
      "gift_type_id": 13,
      "gift_type_name": "Installment",
      "gift_category_id": 0,
      "gift_category_name": null,
      "campaign_id": 0,
      "campaign_name": null,
      "fund_id": 0,
      "fund_name": null,
      "appeal_id": 0,
      "appeal_name": null,
      "event_id": 0,
      "event_name": null,
      "received_amount": 200.0,
      "received_date": null,
      "payment_type_id": null,
      "payment_type_name": null,
      "check_number": null,
      "deductible_amount": 0.0,
      "note": null,
      "ack_template_name": null,
      "deposit_date": null,
      "deposited_amount": 200.0,
      "parent_gift_id": 894305,
      "parent_external_id": "pledge001",
      "tribute_name": null,
      "tributee_name": null,
      "tribute_dedication": null,
      "tribute_recipient_name": null,
      "tribute_recipient_salutation": null,
      "tribute_recipient_email": null,
      "tribute_recipient_address": null,
      "tribute_recipient_notification_template": null,
      "team_member": null,
      "team_member_email": null,
      "custom_fields": {
      }
    },
    {
      "id": 894422,
      "constituent_id": 959466,
      "external_id": "lgl_sample_data-123",
      "is_anon": false,
      "gift_type_id": 1,
      "gift_type_name": "Gift",
      "gift_category_id": 5937,
      "gift_category_name": "Donation",
      "campaign_id": 819,
      "campaign_name": "Annual Giving (sample)",
      "fund_id": 2395,
      "fund_name": "Unrestricted (sample)",
      "appeal_id": 2660,
      "appeal_name": "Board Mailing (sample)",
      "event_id": 0,
      "event_name": null,
      "received_amount": 600.0,
      "received_date": "2023-09-17",
      "payment_type_id": 1508,
      "payment_type_name": "Check",
      "check_number": "6450",
      "deductible_amount": 600.0,
      "note": null,
      "ack_template_name": null,
      "deposit_date": "2023-09-17",
      "deposited_amount": 600.0,
      "parent_gift_id": null,
      "parent_external_id": null,
      "tribute_name": null,
      "tributee_name": null,
      "tribute_dedication": null,
      "tribute_recipient_name": null,
      "tribute_recipient_salutation": null,
      "tribute_recipient_email": null,
      "tribute_recipient_address": null,
      "tribute_recipient_notification_template": null,
      "team_member": null,
      "team_member_email": null,
      "custom_fields": {
      }
    },
    {
      "id": 894400,
      "constituent_id": 959460,
      "external_id": "lgl_sample_data-101",
      "is_anon": false,
      "gift_type_id": 1,
      "gift_type_name": "Gift",
      "gift_category_id": 5937,
      "gift_category_name": "Donation",
      "campaign_id": 819,
      "campaign_name": "Annual Giving (sample)",
      "fund_id": 2395,
      "fund_name": "Unrestricted (sample)",
      "appeal_id": 2660,
      "appeal_name": "Board Mailing (sample)",
      "event_id": 0,
      "event_name": null,
      "received_amount": 500.0,
      "received_date": "2023-09-17",
      "payment_type_id": 1508,
      "payment_type_name": "Check",
      "check_number": "8070",
      "deductible_amount": 500.0,
      "note": "Example of a gift note",
      "ack_template_name": null,
      "deposit_date": "2023-09-17",
      "deposited_amount": 500.0,
      "parent_gift_id": null,
      "parent_external_id": null,
      "tribute_name": null,
      "tributee_name": null,
      "tribute_dedication": null,
      "tribute_recipient_name": null,
      "tribute_recipient_salutation": null,
      "tribute_recipient_email": null,
      "tribute_recipient_address": null,
      "tribute_recipient_notification_template": null,
      "team_member": null,
      "team_member_email": null,
      "custom_fields": {
      }
    },
    {
      "id": 894310,
      "constituent_id": 959438,
      "external_id": "lgl_sample_data-11",
      "is_anon": false,
      "gift_type_id": 1,
      "gift_type_name": "Gift",
      "gift_category_id": 5937,
      "gift_category_name": "Donation",
      "campaign_id": 819,
      "campaign_name": "Annual Giving (sample)",
      "fund_id": 2395,
      "fund_name": "Unrestricted (sample)",
      "appeal_id": 2660,
      "appeal_name": "Board Mailing (sample)",
      "event_id": 0,
      "event_name": null,
      "received_amount": 200.0,
      "received_date": "2023-09-17",
      "payment_type_id": 1508,
      "payment_type_name": "Check",
      "check_number": "8416",
      "deductible_amount": 200.0,
      "note": "Example of a gift note",
      "ack_template_name": null,
      "deposit_date": "2023-09-17",
      "deposited_amount": 200.0,
      "parent_gift_id": 894305,
      "parent_external_id": "pledge001",
      "tribute_name": null,
      "tributee_name": null,
      "tribute_dedication": null,
      "tribute_recipient_name": null,
      "tribute_recipient_salutation": null,
      "tribute_recipient_email": null,
      "tribute_recipient_address": null,
      "tribute_recipient_notification_template": null,
      "team_member": null,
      "team_member_email": null,
      "custom_fields": {
      }
    },
    {
      "id": 894415,
      "constituent_id": 959464,
      "external_id": "lgl_sample_data-116",
      "is_anon": false,
      "gift_type_id": 1,
      "gift_type_name": "Gift",
      "gift_category_id": 5937,
      "gift_category_name": "Donation",
      "campaign_id": 819,
      "campaign_name": "Annual Giving (sample)",
      "fund_id": 2395,
      "fund_name": "Unrestricted (sample)",
      "appeal_id": 2660,
      "appeal_name": "Board Mailing (sample)",
      "event_id": 0,
      "event_name": null,
      "received_amount": 130.0,
      "received_date": "2023-09-17",
      "payment_type_id": 1508,
      "payment_type_name": "Check",
      "check_number": "9720",
      "deductible_amount": 130.0,
      "note": null,
      "ack_template_name": null,
      "deposit_date": "2023-09-17",
      "deposited_amount": 130.0,
      "parent_gift_id": null,
      "parent_external_id": null,
      "tribute_name": null,
      "tributee_name": null,
      "tribute_dedication": null,
      "tribute_recipient_name": null,
      "tribute_recipient_salutation": null,
      "tribute_recipient_email": null,
      "tribute_recipient_address": null,
      "tribute_recipient_notification_template": null,
      "team_member": null,
      "team_member_email": null,
      "custom_fields": {
      }
    }
  ]
}
                

Example - Search by Gift Types and Updated Since:

URI: https://api.littlegreenlight.com/api/v1/gifts/search

Query:
q[]=gift_types=in|1,7;updated_from=2023-01-01&limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 5,
  "total_items": 363,
  "limit": 5,
  "offset": 0,
  "next_item": 5,
  "next_link": "https://api.littlegreenlight.com/api/v1/gifts/search?limit=5&offset=5&q%5B%5D=gift_types%3Din%7C1%2C7%3Bupdated_from%3D2023-01-01",
  "item_type": "gift",
  "items": [
    {
      "id": 894422,
      "constituent_id": 959466,
      "external_id": "lgl_sample_data-123",
      "is_anon": false,
      "gift_type_id": 1,
      "gift_type_name": "Gift",
      "gift_category_id": 5937,
      "gift_category_name": "Donation",
      "campaign_id": 819,
      "campaign_name": "Annual Giving (sample)",
      "fund_id": 2395,
      "fund_name": "Unrestricted (sample)",
      "appeal_id": 2660,
      "appeal_name": "Board Mailing (sample)",
      "event_id": 0,
      "event_name": null,
      "received_amount": 600.0,
      "received_date": "2023-09-17",
      "payment_type_id": 1508,
      "payment_type_name": "Check",
      "check_number": "6450",
      "deductible_amount": 600.0,
      "note": null,
      "ack_template_name": null,
      "deposit_date": "2023-09-17",
      "deposited_amount": 600.0,
      "parent_gift_id": null,
      "parent_external_id": null,
      "tribute_name": null,
      "tributee_name": null,
      "tribute_dedication": null,
      "tribute_recipient_name": null,
      "tribute_recipient_salutation": null,
      "tribute_recipient_email": null,
      "tribute_recipient_address": null,
      "tribute_recipient_notification_template": null,
      "team_member": null,
      "team_member_email": null,
      "custom_fields": {
      }
    },
    {
      "id": 894400,
      "constituent_id": 959460,
      "external_id": "lgl_sample_data-101",
      "is_anon": false,
      "gift_type_id": 1,
      "gift_type_name": "Gift",
      "gift_category_id": 5937,
      "gift_category_name": "Donation",
      "campaign_id": 819,
      "campaign_name": "Annual Giving (sample)",
      "fund_id": 2395,
      "fund_name": "Unrestricted (sample)",
      "appeal_id": 2660,
      "appeal_name": "Board Mailing (sample)",
      "event_id": 0,
      "event_name": null,
      "received_amount": 500.0,
      "received_date": "2023-09-17",
      "payment_type_id": 1508,
      "payment_type_name": "Check",
      "check_number": "8070",
      "deductible_amount": 500.0,
      "note": "Example of a gift note",
      "ack_template_name": null,
      "deposit_date": "2023-09-17",
      "deposited_amount": 500.0,
      "parent_gift_id": null,
      "parent_external_id": null,
      "tribute_name": null,
      "tributee_name": null,
      "tribute_dedication": null,
      "tribute_recipient_name": null,
      "tribute_recipient_salutation": null,
      "tribute_recipient_email": null,
      "tribute_recipient_address": null,
      "tribute_recipient_notification_template": null,
      "team_member": null,
      "team_member_email": null,
      "custom_fields": {
      }
    },
    {
      "id": 894310,
      "constituent_id": 959438,
      "external_id": "lgl_sample_data-11",
      "is_anon": false,
      "gift_type_id": 1,
      "gift_type_name": "Gift",
      "gift_category_id": 5937,
      "gift_category_name": "Donation",
      "campaign_id": 819,
      "campaign_name": "Annual Giving (sample)",
      "fund_id": 2395,
      "fund_name": "Unrestricted (sample)",
      "appeal_id": 2660,
      "appeal_name": "Board Mailing (sample)",
      "event_id": 0,
      "event_name": null,
      "received_amount": 200.0,
      "received_date": "2023-09-17",
      "payment_type_id": 1508,
      "payment_type_name": "Check",
      "check_number": "8416",
      "deductible_amount": 200.0,
      "note": "Example of a gift note",
      "ack_template_name": null,
      "deposit_date": "2023-09-17",
      "deposited_amount": 200.0,
      "parent_gift_id": 894305,
      "parent_external_id": "pledge001",
      "tribute_name": null,
      "tributee_name": null,
      "tribute_dedication": null,
      "tribute_recipient_name": null,
      "tribute_recipient_salutation": null,
      "tribute_recipient_email": null,
      "tribute_recipient_address": null,
      "tribute_recipient_notification_template": null,
      "team_member": null,
      "team_member_email": null,
      "custom_fields": {
      }
    },
    {
      "id": 894415,
      "constituent_id": 959464,
      "external_id": "lgl_sample_data-116",
      "is_anon": false,
      "gift_type_id": 1,
      "gift_type_name": "Gift",
      "gift_category_id": 5937,
      "gift_category_name": "Donation",
      "campaign_id": 819,
      "campaign_name": "Annual Giving (sample)",
      "fund_id": 2395,
      "fund_name": "Unrestricted (sample)",
      "appeal_id": 2660,
      "appeal_name": "Board Mailing (sample)",
      "event_id": 0,
      "event_name": null,
      "received_amount": 130.0,
      "received_date": "2023-09-17",
      "payment_type_id": 1508,
      "payment_type_name": "Check",
      "check_number": "9720",
      "deductible_amount": 130.0,
      "note": null,
      "ack_template_name": null,
      "deposit_date": "2023-09-17",
      "deposited_amount": 130.0,
      "parent_gift_id": null,
      "parent_external_id": null,
      "tribute_name": null,
      "tributee_name": null,
      "tribute_dedication": null,
      "tribute_recipient_name": null,
      "tribute_recipient_salutation": null,
      "tribute_recipient_email": null,
      "tribute_recipient_address": null,
      "tribute_recipient_notification_template": null,
      "team_member": null,
      "team_member_email": null,
      "custom_fields": {
      }
    },
    {
      "id": 894391,
      "constituent_id": 959458,
      "external_id": "lgl_sample_data-92",
      "is_anon": false,
      "gift_type_id": 1,
      "gift_type_name": "Gift",
      "gift_category_id": 5937,
      "gift_category_name": "Donation",
      "campaign_id": 819,
      "campaign_name": "Annual Giving (sample)",
      "fund_id": 2395,
      "fund_name": "Unrestricted (sample)",
      "appeal_id": 2661,
      "appeal_name": "Alumni Mailing (sample)",
      "event_id": 0,
      "event_name": null,
      "received_amount": 110.0,
      "received_date": "2023-09-17",
      "payment_type_id": 1508,
      "payment_type_name": "Check",
      "check_number": "2720",
      "deductible_amount": 110.0,
      "note": null,
      "ack_template_name": null,
      "deposit_date": "2023-09-17",
      "deposited_amount": 110.0,
      "parent_gift_id": null,
      "parent_external_id": null,
      "tribute_name": null,
      "tributee_name": null,
      "tribute_dedication": null,
      "tribute_recipient_name": null,
      "tribute_recipient_salutation": null,
      "tribute_recipient_email": null,
      "tribute_recipient_address": null,
      "tribute_recipient_notification_template": null,
      "team_member": null,
      "team_member_email": null,
      "custom_fields": {
      }
    }
  ]
}
                



GET /api/v1/gifts/{id} - Show Gift details

Show details for the gift.

Parameter Name Description Type Required? Parameter Type
id Gift Id integer true path


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "external_id": 0,
  "is_anon": true,
  "gift_type_id": 0,
  "gift_type_name": "",
  "gift_category_id": 0,
  "gift_category_name": "",
  "campaign_id": 0,
  "campaign_name": "",
  "fund_id": 0,
  "fund_name": "",
  "appeal_id": 0,
  "appeal_name": "",
  "event_id": 0,
  "event_name": "",
  "received_amount": 0,
  "received_date": "",
  "payment_type_id": 0,
  "payment_type_name": "",
  "check_number": "",
  "deductible_amount": 0,
  "note": "",
  "ack_template_name": "",
  "deposit_date": "",
  "deposited_amount": 0,
  "parent_gift_id": 0,
  "parent_external_id": 0,
  "tribute_name": "",
  "tributee_name": "",
  "tribute_dedication": "",
  "tribute_recipient_name": "",
  "tribute_recipient_salutation": "",
  "tribute_recipient_email": "",
  "tribute_recipient_address": "",
  "tribute_recipient_notification_template": "",
  "team_member_email": "",
  "custom_fields": [
    {
      "id": 0,
      "item_type": "",
      "name": "",
      "key": "",
      "facet_type": "",
      "ordinal": 0,
      "removable": true,
      "editable": true,
      "values": [
        {
          "category_id": 0,
          "name": "",
          "description": "",
          "short_code": "",
          "ordinal": 0,
          "removable": true,
          "can_change": true,
          "can_select": true
        }
      ]
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/gifts/894752

Response:
                  
{
  "api_version": "1.0",
  "id": 894752,
  "constituent_id": 959480,
  "external_id": null,
  "is_anon": false,
  "gift_type_id": 1,
  "gift_type_name": "Gift",
  "gift_category_id": 5937,
  "gift_category_name": "Donation",
  "campaign_id": 822,
  "campaign_name": "Annual Giving",
  "fund_id": 2398,
  "fund_name": "General",
  "appeal_id": 2663,
  "appeal_name": "Annual Appeal 2020",
  "event_id": 0,
  "event_name": null,
  "received_amount": 100.0,
  "received_date": "2021-07-01",
  "payment_type_id": 1509,
  "payment_type_name": "Credit Card",
  "check_number": null,
  "deductible_amount": 100.0,
  "note": "See other note",
  "ack_template_name": "Donation Acknowledgment",
  "deposit_date": "2021-07-01",
  "deposited_amount": 100.0,
  "parent_gift_id": null,
  "parent_external_id": null,
  "tribute_name": null,
  "tributee_name": null,
  "tribute_dedication": null,
  "tribute_recipient_name": null,
  "tribute_recipient_salutation": null,
  "tribute_recipient_email": null,
  "tribute_recipient_address": null,
  "tribute_recipient_notification_template": null,
  "team_member": "Nick Bicknell",
  "team_member_email": "team_member@example.com",
  "custom_fields": [
    {
      "id": 1056,
      "item_type": "Gift",
      "name": "Test Gift Field #2",
      "key": "e0c9cb38_48e9_4515_abde_72a6d93722e6",
      "facet_type": "list",
      "ordinal": 100,
      "removable": true,
      "editable": true,
      "values": [
        {
          "id": 12252,
          "category_id": 1056,
          "name": "v1",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true
        }
      ]
    }
  ],
  "created_at": "2024-02-06T15:58:18Z",
  "updated_at": "2024-02-06T15:58:18Z"
}
                



PATCH /api/v1/gifts/{id} - Update Gift

Update the gift.

Parameter Name Description Type Required? Parameter Type
id Gift Id integer true path
body Update Objects UpdateBody true body

UpdateBody

UpdateBody {
external_id ( integer , optional ): External Gift ID,
is_anon ( boolean , optional ): Gift is Anonymous?,
gift_type_id ( integer , required ): Gift type ID,
gift_type_name ( string , required ): Gift type name,
gift_category_id ( integer , optional ): Gift category ID,
gift_category_name ( string , optional ): Gift category name,
campaign_id ( integer , optional ): Campaign ID,
campaign_name ( string , optional ): Campaign name,
fund_id ( integer , optional ): Fund ID,
fund_name ( string , optional ): Fund name,
appeal_id ( integer , optional ): Appeal ID,
appeal_name ( string , optional ): Appeal name,
event_id ( integer , optional ): Event ID,
event_name ( string , optional ): Event name,
received_amount ( double , optional ): Gift amount,
received_date ( date , optional ): Gift date,
payment_type_id ( integer , optional ): Payment type ID,
payment_type_name ( string , optional ): Payment type name,
check_number ( string , optional ): Check/Reference No.,
deductible_amount ( double , optional ): Tax deductible amount,
note ( string , optional ): Gift note,
ack_template_name ( string , optional ): Ack. mailing template name. (use 'do_not_ack' to indicate no acknowledgment),
deposit_date ( date , optional ): Deposit Date,
deposited_amount ( double , optional ): Deposit Amount,
parent_gift_id ( integer , optional ): LGL parent gift ID,
parent_external_id ( integer , optional ): External parent gift ID,
tribute_name ( string , optional ): The name of tribute. Values: "Honorary - General", "Memorial - General", or a pre-defined named tribute,
tributee_name ( string , optional ): The name of the honoree/deceased,
tribute_dedication ( string , optional ): The tribute dedication note/text for a gift,
tribute_recipient_name ( string , optional ): The name of person who should be notified about this tribute gift.,
tribute_recipient_salutation ( string , optional ): The name of person who should be notified about this tribute gift.,
tribute_recipient_email ( string , optional ): The email of the person who should be notified about this tribute gift.,
tribute_recipient_address ( string , optional ): The address of the person who should be notified about this tribute gift.,
tribute_recipient_notification_template ( string , optional ): The notification template to be used for the person who should be notified about this tribute gift.,
team_member ( string , optional ): Team Member ('id', 'email', or 'first_name last_name'),
custom_fields ( array , optional , CustomFieldAggregatedUpdate ): Gift custom fields (Categories)
}
CustomFieldAggregatedUpdate {
id ( integer , optional ): Custom Field Id,
name ( string , required ): Name,
key ( string , optional ): Key,
remove_previous_values ( boolean , optional ): Remove previous field values,
values ( array , required , CustomValueAggregatedUpdate ): Values
}
CustomValueAggregatedUpdate {
id ( integer , required ): Value Id,
name ( string , required ): Name
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "external_id": 0,
  "is_anon": true,
  "gift_type_id": 0,
  "gift_type_name": "",
  "gift_category_id": 0,
  "gift_category_name": "",
  "campaign_id": 0,
  "campaign_name": "",
  "fund_id": 0,
  "fund_name": "",
  "appeal_id": 0,
  "appeal_name": "",
  "event_id": 0,
  "event_name": "",
  "received_amount": 0,
  "received_date": "",
  "payment_type_id": 0,
  "payment_type_name": "",
  "check_number": "",
  "deductible_amount": 0,
  "note": "",
  "ack_template_name": "",
  "deposit_date": "",
  "deposited_amount": 0,
  "parent_gift_id": 0,
  "parent_external_id": 0,
  "tribute_name": "",
  "tributee_name": "",
  "tribute_dedication": "",
  "tribute_recipient_name": "",
  "tribute_recipient_salutation": "",
  "tribute_recipient_email": "",
  "tribute_recipient_address": "",
  "tribute_recipient_notification_template": "",
  "team_member_email": "",
  "custom_fields": [
    {
      "id": 0,
      "item_type": "",
      "name": "",
      "key": "",
      "facet_type": "",
      "ordinal": 0,
      "removable": true,
      "editable": true,
      "values": [
        {
          "category_id": 0,
          "name": "",
          "description": "",
          "short_code": "",
          "ordinal": 0,
          "removable": true,
          "can_change": true,
          "can_select": true
        }
      ]
    }
  ]
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example - Add Event and Custom Field Value:

URI: https://api.littlegreenlight.com/api/v1/gifts/894752

Body:
                  
{
  "event_name": "Winter 2020 Fundraising Gala",
  "custom_fields": [
    {
      "name": "Test Gift Field #2",
      "values": [
        {
          "name": "v2"
        }
      ]
    }
  ]
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 894752,
  "constituent_id": 959480,
  "external_id": null,
  "is_anon": false,
  "gift_type_id": 1,
  "gift_type_name": "Gift",
  "gift_category_id": 5937,
  "gift_category_name": "Donation",
  "campaign_id": 822,
  "campaign_name": "Annual Giving",
  "fund_id": 2398,
  "fund_name": "General",
  "appeal_id": 2663,
  "appeal_name": "Annual Appeal 2020",
  "event_id": 1069,
  "event_name": "Winter 2020 Fundraising Gala",
  "received_amount": 100.0,
  "received_date": "2021-07-01",
  "payment_type_id": 1509,
  "payment_type_name": "Credit Card",
  "check_number": null,
  "deductible_amount": 100.0,
  "note": "See other note",
  "ack_template_name": "Donation Acknowledgment",
  "deposit_date": "2021-07-01",
  "deposited_amount": 100.0,
  "parent_gift_id": null,
  "parent_external_id": null,
  "tribute_name": null,
  "tributee_name": null,
  "tribute_dedication": null,
  "tribute_recipient_name": null,
  "tribute_recipient_salutation": null,
  "tribute_recipient_email": null,
  "tribute_recipient_address": null,
  "tribute_recipient_notification_template": null,
  "team_member": "Nick Bicknell",
  "team_member_email": "team_member@example.com",
  "custom_fields": [
    {
      "id": 1056,
      "item_type": "Gift",
      "name": "Test Gift Field #2",
      "key": "e0c9cb38_48e9_4515_abde_72a6d93722e6",
      "facet_type": "list",
      "ordinal": 100,
      "removable": true,
      "editable": true,
      "values": [
        {
          "id": 12252,
          "category_id": 1056,
          "name": "v1",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true
        },
        {
          "id": 12253,
          "category_id": 1056,
          "name": "v2",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true
        }
      ]
    }
  ],
  "created_at": "2024-02-06T15:58:18Z",
  "updated_at": "2024-02-06T15:58:21Z"
}
                

Example - Replace Previous Custom Field Values with New Value:

URI: https://api.littlegreenlight.com/api/v1/gifts/894752

Body:
                  
{
  "custom_fields": [
    {
      "name": "Test Gift Field #2",
      "remove_previous_values": true,
      "values": [
        {
          "name": "v3"
        }
      ]
    }
  ]
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 894752,
  "constituent_id": 959480,
  "external_id": null,
  "is_anon": false,
  "gift_type_id": 1,
  "gift_type_name": "Gift",
  "gift_category_id": 5937,
  "gift_category_name": "Donation",
  "campaign_id": 822,
  "campaign_name": "Annual Giving",
  "fund_id": 2398,
  "fund_name": "General",
  "appeal_id": 2663,
  "appeal_name": "Annual Appeal 2020",
  "event_id": 1069,
  "event_name": "Winter 2020 Fundraising Gala",
  "received_amount": 100.0,
  "received_date": "2021-07-01",
  "payment_type_id": 1509,
  "payment_type_name": "Credit Card",
  "check_number": null,
  "deductible_amount": 100.0,
  "note": "See other note",
  "ack_template_name": "Donation Acknowledgment",
  "deposit_date": "2021-07-01",
  "deposited_amount": 100.0,
  "parent_gift_id": null,
  "parent_external_id": null,
  "tribute_name": null,
  "tributee_name": null,
  "tribute_dedication": null,
  "tribute_recipient_name": null,
  "tribute_recipient_salutation": null,
  "tribute_recipient_email": null,
  "tribute_recipient_address": null,
  "tribute_recipient_notification_template": null,
  "team_member": "Nick Bicknell",
  "team_member_email": "team_member@example.com",
  "custom_fields": [
    {
      "id": 1056,
      "item_type": "Gift",
      "name": "Test Gift Field #2",
      "key": "e0c9cb38_48e9_4515_abde_72a6d93722e6",
      "facet_type": "list",
      "ordinal": 100,
      "removable": true,
      "editable": true,
      "values": [
        {
          "id": 12254,
          "category_id": 1056,
          "name": "v3",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true
        }
      ]
    }
  ],
  "created_at": "2024-02-06T15:58:18Z",
  "updated_at": "2024-02-06T15:58:21Z"
}
                



DELETE /api/v1/gifts/{id} - Delete Gift

Delete the gift.

Parameter Name Description Type Required? Parameter Type
id Gift Id integer true path


Code Message Response
200 Ok
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/gifts/894752

Response:
                  
{
  "api_version": "1.0",
  "result": "success"
}
                

Example:

URI: https://api.littlegreenlight.com/api/v1/gifts/894753

Response:
                  
{
  "api_version": "1.0",
  "result": "success"
}
                



Group Memberships Management

GET /api/v1/group_memberships/{id} - Show Group Membership details

Show details for the group membership.

Parameter Name Description Type Required? Parameter Type
id Group Membership Id integer true path


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "group_id": 0,
  "group_name": "",
  "date_start": "",
  "date_end": "",
  "is_current": true,
  "created_at": "",
  "updated_at": ""
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/group_memberships/595500

Response:
                  
{
  "api_version": "1.0",
  "id": 595500,
  "constituent_id": 959566,
  "group_id": 3241,
  "group_name": "Board Member",
  "date_start": null,
  "date_end": null,
  "is_current": true,
  "created_at": "2024-02-06T15:58:12Z",
  "updated_at": "2024-02-06T15:58:12Z"
}
                



PATCH /api/v1/group_memberships/{id} - Update Group Membership

Update the group membership.

Parameter Name Description Type Required? Parameter Type
id Group Membership Id integer true path
body Update Objects UpdateBody true body

UpdateBody

UpdateBody {
constituent_id ( integer , optional ): Constituent Id,
group_id ( integer , required ): Group Id,
group_name ( string , optional ): Group Name,
date_start ( date , optional ): Start Date,
date_end ( date , optional ): End Date,
is_current ( boolean , optional ): Current?
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "group_id": 0,
  "group_name": "",
  "date_start": "",
  "date_end": "",
  "is_current": true,
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/group_memberships/595500

Body:
                  
{
  "date_start": "2016-01-01"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 595500,
  "constituent_id": 959566,
  "group_id": 3241,
  "group_name": "Board Member",
  "date_start": "2016-01-01",
  "date_end": null,
  "is_current": true,
  "created_at": "2024-02-06T15:58:12Z",
  "updated_at": "2024-02-06T15:58:22Z"
}
                



DELETE /api/v1/group_memberships/{id} - Delete Group Membership

Delete the group membership.

Parameter Name Description Type Required? Parameter Type
id Group Membership Id integer true path


Code Message Response
200 Ok
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/group_memberships/595500

Response:
                  
{
  "api_version": "1.0",
  "result": "success"
}
                



GET /api/v1/constituents/{constituent_id}/group_memberships - Fetch Group Memberships

Lists all the group memberships.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "constituent_id": 0,
      "group_id": 0,
      "group_name": "",
      "date_start": "",
      "date_end": "",
      "is_current": true,
      "created_at": "",
      "updated_at": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/group_memberships

Response:
                  
{
  "api_version": "1.0",
  "items_count": 1,
  "total_items": 1,
  "limit": 25,
  "offset": 0,
  "item_type": "group_membership",
  "items": [
    {
      "id": 595476,
      "constituent_id": 959480,
      "group_id": 3241,
      "group_name": "Board Member",
      "date_start": null,
      "date_end": null,
      "is_current": true,
      "created_at": "2023-09-19T22:24:37Z",
      "updated_at": "2023-09-19T22:24:37Z"
    }
  ]
}
                



POST /api/v1/constituents/{constituent_id}/group_memberships - Create new Group Membership

Add group membership.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
body Create Objects CreateBody true body

CreateBody

CreateBody {
group_id ( integer , required ): Group Id,
group_name ( string , optional ): Group Name,
date_start ( date , optional ): Start Date,
date_end ( date , optional ): End Date,
is_current ( boolean , optional ): Current?
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "group_id": 0,
  "group_name": "",
  "date_start": "",
  "date_end": "",
  "is_current": true,
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity



Groups Management

GET /api/v1/groups - Fetch Groups

Lists all the groups.

Parameter Name Description Type Required? Parameter Type
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "name": "",
      "key": "",
      "ordinal": 0
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/groups

Response:
                  
{
  "api_version": "1.0",
  "items_count": 4,
  "total_items": 4,
  "limit": 25,
  "offset": 0,
  "item_type": "group",
  "items": [
    {
      "id": 3240,
      "name": "Team Member",
      "key": "team_member",
      "ordinal": 0
    },
    {
      "id": 3241,
      "name": "Board Member",
      "key": "board_member",
      "ordinal": 0
    },
    {
      "id": 3242,
      "name": "Staff",
      "key": "staff",
      "ordinal": 0
    },
    {
      "id": 3243,
      "name": "Volunteer",
      "key": "volunteer",
      "ordinal": 0
    }
  ]
}
                



POST /api/v1/groups - Create new Group

Add group.

Parameter Name Description Type Required? Parameter Type
body Create Objects CreateBody true body

CreateBody

CreateBody {
name ( string , required ): Name,
key ( string , optional ): Key,
ordinal ( integer , optional ): Ordinal
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "name": "",
  "key": "",
  "ordinal": 0
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/groups

Body:
                  
{
  "name": "New Group"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 3289,
  "name": "New Group",
  "key": "new_group",
  "ordinal": 0
}
                



GET /api/v1/groups/{id} - Show Group details

Show details for the group.

Parameter Name Description Type Required? Parameter Type
id Group Id integer true path


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "name": "",
  "key": "",
  "ordinal": 0
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/groups/3289

Response:
                  
{
  "api_version": "1.0",
  "id": 3289,
  "name": "New Group",
  "key": "new_group",
  "ordinal": 0
}
                



PATCH /api/v1/groups/{id} - Update Group

Update the group.

Parameter Name Description Type Required? Parameter Type
id Group Id integer true path
body Update Objects UpdateBody true body

UpdateBody

UpdateBody {
name ( string , required ): Name,
key ( string , optional ): Key,
ordinal ( integer , optional ): Ordinal
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "name": "",
  "key": "",
  "ordinal": 0
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/groups/3289

Body:
                  
{
  "ordinal": "10"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 3289,
  "name": "New Group",
  "key": "new_group",
  "ordinal": 10
}
                



DELETE /api/v1/groups/{id} - Delete Group

Delete the group.

Parameter Name Description Type Required? Parameter Type
id Group Id integer true path


Code Message Response
200 Ok
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/groups/3289

Response:
                  
{
  "api_version": "1.0",
  "result": "success"
}
                



Invitations Management

POST /api/v1/constituents/{constituent_id}/invitations - Create new Invitation for Constituent

Add invitation to constituent.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
body Create Objects CreateBody_Const true body

CreateBody_Const

CreateBody_Const {
event_id ( integer , required ): Event Id,
parent_invitation_id ( integer , optional ): Parent Invitation Id (for additional guests),
notes ( string , optional ): Notes,
rsvp ( integer , optional ): RSVP (1-Yes, 2-No, 3-Maybe, 4-Unknown),
attended ( integer , optional ): Attended,
assigned_to ( integer , optional ): Assigned to,
attendee_names ( string , optional ): Attendees Names,
guest_first_name ( string , optional ): Additional Guest First Name,
guest_last_name ( string , optional ): Additional Guest Last Name,
is_a_guest ( boolean , optional ): Creating an additional guest record,
attendances ( array , optional , Attendance_create ): Multiple attendances,
custom_fields ( array , optional , CustomFieldAggregatedUpdate ): Invitation custom fields (Categories),
custom_attrs ( array , optional , CustomAttr_create ): Invitation custom attrubutes
}
Attendance_create {
date ( date , required ): Attendance date,
notes ( string , optional ): Attendance notes
}
CustomFieldAggregatedUpdate {
id ( integer , optional ): Custom Field Id,
name ( string , required ): Name,
key ( string , optional ): Key,
remove_previous_values ( boolean , optional ): Remove previous field values,
values ( array , required , CustomValueAggregatedUpdate ): Values
}
CustomValueAggregatedUpdate {
id ( integer , required ): Value Id,
name ( string , required ): Name
}
CustomAttr_create {
id ( integer , optional ): Custom Field Id,
key ( string , optional ): Key,
value ( string , required ): Value
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "guest_name": "",
  "is_a_guest": true,
  "parent_invitation_id": 0,
  "parent_invitation_guest_name": "",
  "event_id": 0,
  "name": "",
  "notes": "",
  "rsvp": 0,
  "attended": 0,
  "raised": 0,
  "status": "",
  "donated": true,
  "assigned_to": 0,
  "additional_guests": 0,
  "attendees": 0,
  "attendee_names": "",
  "attend_count": 0,
  "attendances": [
    {
      "id": 0,
      "date": "",
      "notes": ""
    }
  ],
  "custom_fields": [
    {
      "id": 0,
      "item_type": "",
      "name": "",
      "key": "",
      "facet_type": "",
      "ordinal": 0,
      "removable": true,
      "editable": true,
      "values": [
        {
          "category_id": 0,
          "name": "",
          "description": "",
          "short_code": "",
          "ordinal": 0,
          "removable": true,
          "can_change": true,
          "can_select": true
        }
      ]
    }
  ],
  "custom_attrs": [
    {
      "id": 0,
      "classification": "",
      "name": "",
      "key": "",
      "ordinal": 0,
      "value": ""
    }
  ],
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/invitations

Body:
                  
{
  "event_id": "1069"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 168333,
  "constituent_id": 959480,
  "guest_name": "Larry Appleton",
  "is_a_guest": false,
  "parent_invitation_id": 0,
  "parent_invitation_guest_name": null,
  "event_id": 1069,
  "name": "Event: Winter 2020 Fundraising Gala",
  "notes": null,
  "rsvp": 0,
  "attended": 0,
  "raised": 0.0,
  "status": "unknown",
  "donated": false,
  "assigned_to": null,
  "additional_guests": 0,
  "attendees": 0,
  "attendee_names": null,
  "attend_count": 0,
  "attendances": [

  ],
  "custom_fields": [

  ],
  "custom_attrs": [

  ],
  "created_at": "2024-02-06T15:58:24Z",
  "updated_at": "2024-02-06T15:58:24Z"
}
                



GET /api/v1/constituents/{constituent_id}/invitations - Fetch Invitations for Constituent

Lists all the invitations for a constituent.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "constituent_id": 0,
      "guest_name": "",
      "is_a_guest": true,
      "parent_invitation_id": 0,
      "parent_invitation_guest_name": "",
      "event_id": 0,
      "name": "",
      "notes": "",
      "rsvp": 0,
      "attended": 0,
      "raised": 0,
      "status": "",
      "donated": true,
      "assigned_to": 0,
      "additional_guests": 0,
      "attendees": 0,
      "attendee_names": "",
      "attend_count": 0,
      "attendances": [
        {
          "id": 0,
          "date": "",
          "notes": ""
        }
      ],
      "custom_fields": [
        {
          "id": 0,
          "item_type": "",
          "name": "",
          "key": "",
          "facet_type": "",
          "ordinal": 0,
          "removable": true,
          "editable": true,
          "values": [
            {
              "category_id": 0,
              "name": "",
              "description": "",
              "short_code": "",
              "ordinal": 0,
              "removable": true,
              "can_change": true,
              "can_select": true
            }
          ]
        }
      ],
      "custom_attrs": [
        {
          "id": 0,
          "classification": "",
          "name": "",
          "key": "",
          "ordinal": 0,
          "value": ""
        }
      ],
      "created_at": "",
      "updated_at": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/invitations

Query:
limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 1,
  "total_items": 1,
  "limit": 5,
  "offset": 0,
  "item_type": "invitation",
  "items": [
    {
      "id": 168333,
      "constituent_id": 959480,
      "guest_name": "Larry Appleton",
      "is_a_guest": false,
      "parent_invitation_id": 0,
      "parent_invitation_guest_name": null,
      "event_id": 1069,
      "name": "Event: Winter 2020 Fundraising Gala",
      "notes": null,
      "rsvp": 0,
      "attended": 0,
      "raised": 0.0,
      "status": "unknown",
      "donated": false,
      "assigned_to": null,
      "additional_guests": 0,
      "attendees": 0,
      "attendee_names": null,
      "attend_count": 0,
      "attendances": [

      ],
      "custom_fields": [

      ],
      "custom_attrs": [

      ],
      "created_at": "2024-02-06T15:58:24Z",
      "updated_at": "2024-02-06T15:58:24Z"
    }
  ]
}
                



GET /api/v1/events/{event_id}/invitations - Fetch Invitations for Event

Lists all the invitations for an event.

Parameter Name Description Type Required? Parameter Type
event_id Event Id integer true path
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "constituent_id": 0,
      "guest_name": "",
      "is_a_guest": true,
      "parent_invitation_id": 0,
      "parent_invitation_guest_name": "",
      "event_id": 0,
      "name": "",
      "notes": "",
      "rsvp": 0,
      "attended": 0,
      "raised": 0,
      "status": "",
      "donated": true,
      "assigned_to": 0,
      "additional_guests": 0,
      "attendees": 0,
      "attendee_names": "",
      "attend_count": 0,
      "attendances": [
        {
          "id": 0,
          "date": "",
          "notes": ""
        }
      ],
      "custom_fields": [
        {
          "id": 0,
          "item_type": "",
          "name": "",
          "key": "",
          "facet_type": "",
          "ordinal": 0,
          "removable": true,
          "editable": true,
          "values": [
            {
              "category_id": 0,
              "name": "",
              "description": "",
              "short_code": "",
              "ordinal": 0,
              "removable": true,
              "can_change": true,
              "can_select": true
            }
          ]
        }
      ],
      "custom_attrs": [
        {
          "id": 0,
          "classification": "",
          "name": "",
          "key": "",
          "ordinal": 0,
          "value": ""
        }
      ],
      "created_at": "",
      "updated_at": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/events/1069/invitations

Query:
limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 5,
  "total_items": 83,
  "limit": 5,
  "offset": 0,
  "next_item": 5,
  "next_link": "https://api.littlegreenlight.com/api/v1/events/1069/invitations?limit=5&offset=5",
  "item_type": "invitation",
  "items": [
    {
      "id": 168229,
      "constituent_id": 959486,
      "guest_name": "Archer's",
      "is_a_guest": false,
      "parent_invitation_id": 0,
      "parent_invitation_guest_name": null,
      "event_id": 1069,
      "name": "Event: Winter 2020 Fundraising Gala",
      "notes": null,
      "rsvp": 0,
      "attended": 0,
      "raised": 0.0,
      "status": "unknown",
      "donated": false,
      "assigned_to": null,
      "additional_guests": 0,
      "attendees": 0,
      "attendee_names": null,
      "attend_count": 0,
      "attendances": [

      ],
      "custom_fields": [

      ],
      "custom_attrs": [

      ],
      "created_at": "2023-10-31T17:41:28Z",
      "updated_at": "2023-10-31T17:41:28Z"
    },
    {
      "id": 168230,
      "constituent_id": 959440,
      "guest_name": "Avengers Mansion Headquarters of the Avengers",
      "is_a_guest": false,
      "parent_invitation_id": 0,
      "parent_invitation_guest_name": null,
      "event_id": 1069,
      "name": "Event: Winter 2020 Fundraising Gala",
      "notes": null,
      "rsvp": 0,
      "attended": 0,
      "raised": 0.0,
      "status": "unknown",
      "donated": false,
      "assigned_to": null,
      "additional_guests": 0,
      "attendees": 0,
      "attendee_names": null,
      "attend_count": 0,
      "attendances": [

      ],
      "custom_fields": [

      ],
      "custom_attrs": [

      ],
      "created_at": "2023-10-31T17:41:28Z",
      "updated_at": "2023-10-31T17:41:28Z"
    },
    {
      "id": 168231,
      "constituent_id": 959453,
      "guest_name": "Ray Barone",
      "is_a_guest": false,
      "parent_invitation_id": 0,
      "parent_invitation_guest_name": null,
      "event_id": 1069,
      "name": "Event: Winter 2020 Fundraising Gala",
      "notes": null,
      "rsvp": 0,
      "attended": 0,
      "raised": 0.0,
      "status": "unknown",
      "donated": false,
      "assigned_to": null,
      "additional_guests": 0,
      "attendees": 0,
      "attendee_names": null,
      "attend_count": 0,
      "attendances": [

      ],
      "custom_fields": [

      ],
      "custom_attrs": [

      ],
      "created_at": "2023-10-31T17:41:28Z",
      "updated_at": "2023-10-31T17:41:28Z"
    },
    {
      "id": 168232,
      "constituent_id": 959465,
      "guest_name": "Joseph Baxter",
      "is_a_guest": false,
      "parent_invitation_id": 0,
      "parent_invitation_guest_name": null,
      "event_id": 1069,
      "name": "Event: Winter 2020 Fundraising Gala",
      "notes": null,
      "rsvp": 0,
      "attended": 0,
      "raised": 0.0,
      "status": "unknown",
      "donated": false,
      "assigned_to": null,
      "additional_guests": 0,
      "attendees": 0,
      "attendee_names": null,
      "attend_count": 0,
      "attendances": [

      ],
      "custom_fields": [

      ],
      "custom_attrs": [

      ],
      "created_at": "2023-10-31T17:41:28Z",
      "updated_at": "2023-10-31T17:41:28Z"
    },
    {
      "id": 168233,
      "constituent_id": 959474,
      "guest_name": "Frank Black",
      "is_a_guest": false,
      "parent_invitation_id": 0,
      "parent_invitation_guest_name": null,
      "event_id": 1069,
      "name": "Event: Winter 2020 Fundraising Gala",
      "notes": null,
      "rsvp": 0,
      "attended": 0,
      "raised": 0.0,
      "status": "unknown",
      "donated": false,
      "assigned_to": null,
      "additional_guests": 0,
      "attendees": 0,
      "attendee_names": null,
      "attend_count": 0,
      "attendances": [

      ],
      "custom_fields": [

      ],
      "custom_attrs": [

      ],
      "created_at": "2023-10-31T17:41:28Z",
      "updated_at": "2023-10-31T17:41:28Z"
    }
  ]
}
                



POST /api/v1/events/{event_id}/invitations - Create new Invitation

Add invitation.

Parameter Name Description Type Required? Parameter Type
event_id Event Id integer true path
body Create Objects CreateBody true body

CreateBody

CreateBody {
constituent_id ( integer , required ): Constituent Id,
parent_invitation_id ( integer , optional ): Parent Invitation Id (for additional guests),
notes ( string , optional ): Notes,
rsvp ( integer , optional ): RSVP (1-Yes, 2-No, 3-Maybe, 4-Unknown),
attended ( integer , optional ): Attended,
assigned_to ( integer , optional ): Assigned to,
attendee_names ( string , optional ): Attendees Names,
guest_first_name ( string , optional ): Additional Guest First Name,
guest_last_name ( string , optional ): Additional Guest Last Name,
is_a_guest ( boolean , optional ): Creating an additional guest record,
attendances ( array , optional , Attendance_create ): Multiple attendances,
custom_fields ( array , optional , CustomFieldAggregatedUpdate ): Invitation custom fields (Categories),
custom_attrs ( array , optional , CustomAttr_create ): Invitation custom attrubutes
}
Attendance_create {
date ( date , required ): Attendance date,
notes ( string , optional ): Attendance notes
}
CustomFieldAggregatedUpdate {
id ( integer , optional ): Custom Field Id,
name ( string , required ): Name,
key ( string , optional ): Key,
remove_previous_values ( boolean , optional ): Remove previous field values,
values ( array , required , CustomValueAggregatedUpdate ): Values
}
CustomValueAggregatedUpdate {
id ( integer , required ): Value Id,
name ( string , required ): Name
}
CustomAttr_create {
id ( integer , optional ): Custom Field Id,
key ( string , optional ): Key,
value ( string , required ): Value
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "guest_name": "",
  "is_a_guest": true,
  "parent_invitation_id": 0,
  "parent_invitation_guest_name": "",
  "event_id": 0,
  "name": "",
  "notes": "",
  "rsvp": 0,
  "attended": 0,
  "raised": 0,
  "status": "",
  "donated": true,
  "assigned_to": 0,
  "additional_guests": 0,
  "attendees": 0,
  "attendee_names": "",
  "attend_count": 0,
  "attendances": [
    {
      "id": 0,
      "date": "",
      "notes": ""
    }
  ],
  "custom_fields": [
    {
      "id": 0,
      "item_type": "",
      "name": "",
      "key": "",
      "facet_type": "",
      "ordinal": 0,
      "removable": true,
      "editable": true,
      "values": [
        {
          "category_id": 0,
          "name": "",
          "description": "",
          "short_code": "",
          "ordinal": 0,
          "removable": true,
          "can_change": true,
          "can_select": true
        }
      ]
    }
  ],
  "custom_attrs": [
    {
      "id": 0,
      "classification": "",
      "name": "",
      "key": "",
      "ordinal": 0,
      "value": ""
    }
  ],
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example - Create invitation for an event:

URI: https://api.littlegreenlight.com/api/v1/events/1070/invitations

Body:
                  
{
  "constituent_id": "959480",
  "notes": "Event note"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 168334,
  "constituent_id": 959480,
  "guest_name": "Larry Appleton",
  "is_a_guest": false,
  "parent_invitation_id": 0,
  "parent_invitation_guest_name": null,
  "event_id": 1070,
  "name": "Event: Board weekend",
  "notes": "Event note",
  "rsvp": 0,
  "attended": 0,
  "raised": 0.0,
  "status": "unknown",
  "donated": false,
  "assigned_to": null,
  "additional_guests": 0,
  "attendees": 0,
  "attendee_names": null,
  "attend_count": 0,
  "attendances": [

  ],
  "custom_fields": [

  ],
  "custom_attrs": [

  ],
  "created_at": "2024-02-06T15:58:25Z",
  "updated_at": "2024-02-06T15:58:25Z"
}
                

Example - Create an additional guest for an invitation:

URI: https://api.littlegreenlight.com/api/v1/events/1069/invitations

Body:
                  
{
  "parent_invitation_id": "168333",
  "guest_first_name": "Max",
  "guest_last_name": "Million",
  "is_a_guest": true
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 168335,
  "constituent_id": null,
  "guest_name": "Max Million",
  "is_a_guest": true,
  "parent_invitation_id": 168333,
  "parent_invitation_guest_name": "Larry Appleton",
  "event_id": 1069,
  "name": "Event: Winter 2020 Fundraising Gala",
  "notes": null,
  "rsvp": 0,
  "attended": 0,
  "raised": 0.0,
  "status": "unknown",
  "donated": false,
  "assigned_to": null,
  "additional_guests": 0,
  "attendees": 0,
  "attendee_names": null,
  "attend_count": 0,
  "attendances": [

  ],
  "custom_fields": [

  ],
  "custom_attrs": [

  ],
  "created_at": "2024-02-06T15:58:25Z",
  "updated_at": "2024-02-06T15:58:25Z"
}
                



GET /api/v1/invitations/{id} - Show Invitation details

Show details for the invitation.

Parameter Name Description Type Required? Parameter Type
id Invitation Id integer true path


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "guest_name": "",
  "is_a_guest": true,
  "parent_invitation_id": 0,
  "parent_invitation_guest_name": "",
  "event_id": 0,
  "name": "",
  "notes": "",
  "rsvp": 0,
  "attended": 0,
  "raised": 0,
  "status": "",
  "donated": true,
  "assigned_to": 0,
  "additional_guests": 0,
  "attendees": 0,
  "attendee_names": "",
  "attend_count": 0,
  "attendances": [
    {
      "id": 0,
      "date": "",
      "notes": ""
    }
  ],
  "custom_fields": [
    {
      "id": 0,
      "item_type": "",
      "name": "",
      "key": "",
      "facet_type": "",
      "ordinal": 0,
      "removable": true,
      "editable": true,
      "values": [
        {
          "category_id": 0,
          "name": "",
          "description": "",
          "short_code": "",
          "ordinal": 0,
          "removable": true,
          "can_change": true,
          "can_select": true
        }
      ]
    }
  ],
  "custom_attrs": [
    {
      "id": 0,
      "classification": "",
      "name": "",
      "key": "",
      "ordinal": 0,
      "value": ""
    }
  ],
  "created_at": "",
  "updated_at": ""
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/invitations/168333

Response:
                  
{
  "api_version": "1.0",
  "id": 168333,
  "constituent_id": 959480,
  "guest_name": "Larry Appleton",
  "is_a_guest": false,
  "parent_invitation_id": 0,
  "parent_invitation_guest_name": null,
  "event_id": 1069,
  "name": "Event: Winter 2020 Fundraising Gala",
  "notes": null,
  "rsvp": 0,
  "attended": 0,
  "raised": 0.0,
  "status": "unknown",
  "donated": false,
  "assigned_to": null,
  "additional_guests": 1,
  "attendees": 0,
  "attendee_names": null,
  "attend_count": 0,
  "attendances": [

  ],
  "custom_fields": [

  ],
  "custom_attrs": [

  ],
  "created_at": "2024-02-06T15:58:24Z",
  "updated_at": "2024-02-06T15:58:24Z"
}
                



PATCH /api/v1/invitations/{id} - Update Invitation

Update the invitation.

Parameter Name Description Type Required? Parameter Type
id Invitation Id integer true path
body Update Objects UpdateBody true body

UpdateBody

UpdateBody {
constituent_id ( integer , required ): Constituent Id,
parent_invitation_id ( integer , optional ): Parent Invitation Id (for additional guests),
notes ( string , optional ): Notes,
rsvp ( integer , optional ): RSVP (1-Yes, 2-No, 3-Maybe, 4-Unknown),
attended ( integer , optional ): Attended,
assigned_to ( integer , optional ): Assigned to,
attendee_names ( string , optional ): Attendees Names,
guest_first_name ( string , optional ): Additional Guest First Name,
guest_last_name ( string , optional ): Additional Guest Last Name,
is_a_guest ( boolean , optional ): Creating an additional guest record,
attendances ( array , optional , Attendance_create ): Multiple attendances,
custom_fields ( array , optional , CustomFieldAggregatedUpdate ): Invitation custom fields (Categories),
custom_attrs ( array , optional , CustomAttr_create ): Invitation custom attrubutes
}
Attendance_create {
date ( date , required ): Attendance date,
notes ( string , optional ): Attendance notes
}
CustomFieldAggregatedUpdate {
id ( integer , optional ): Custom Field Id,
name ( string , required ): Name,
key ( string , optional ): Key,
remove_previous_values ( boolean , optional ): Remove previous field values,
values ( array , required , CustomValueAggregatedUpdate ): Values
}
CustomValueAggregatedUpdate {
id ( integer , required ): Value Id,
name ( string , required ): Name
}
CustomAttr_create {
id ( integer , optional ): Custom Field Id,
key ( string , optional ): Key,
value ( string , required ): Value
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "guest_name": "",
  "is_a_guest": true,
  "parent_invitation_id": 0,
  "parent_invitation_guest_name": "",
  "event_id": 0,
  "name": "",
  "notes": "",
  "rsvp": 0,
  "attended": 0,
  "raised": 0,
  "status": "",
  "donated": true,
  "assigned_to": 0,
  "additional_guests": 0,
  "attendees": 0,
  "attendee_names": "",
  "attend_count": 0,
  "attendances": [
    {
      "id": 0,
      "date": "",
      "notes": ""
    }
  ],
  "custom_fields": [
    {
      "id": 0,
      "item_type": "",
      "name": "",
      "key": "",
      "facet_type": "",
      "ordinal": 0,
      "removable": true,
      "editable": true,
      "values": [
        {
          "category_id": 0,
          "name": "",
          "description": "",
          "short_code": "",
          "ordinal": 0,
          "removable": true,
          "can_change": true,
          "can_select": true
        }
      ]
    }
  ],
  "custom_attrs": [
    {
      "id": 0,
      "classification": "",
      "name": "",
      "key": "",
      "ordinal": 0,
      "value": ""
    }
  ],
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/invitations/168334

Body:
                  
{
  "rsvp": "2",
  "attendances": [
    {
      "date": "2023-07-01",
      "notes": "attended"
    },
    {
      "date": "2023-08-01",
      "notes": "attended"
    }
  ]
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 168334,
  "constituent_id": 959480,
  "guest_name": "Larry Appleton",
  "is_a_guest": false,
  "parent_invitation_id": 0,
  "parent_invitation_guest_name": null,
  "event_id": 1070,
  "name": "Event: Board weekend",
  "notes": "Event note",
  "rsvp": 2,
  "attended": 1,
  "raised": 0.0,
  "status": "attended",
  "donated": false,
  "assigned_to": null,
  "additional_guests": 0,
  "attendees": 1,
  "attendee_names": null,
  "attend_count": 0,
  "attendances": [
    {
      "id": 63,
      "date": "2023-07-01",
      "notes": "attended"
    },
    {
      "id": 64,
      "date": "2023-08-01",
      "notes": "attended"
    }
  ],
  "custom_fields": [

  ],
  "custom_attrs": [

  ],
  "created_at": "2024-02-06T15:58:25Z",
  "updated_at": "2024-02-06T15:58:26Z"
}
                



DELETE /api/v1/invitations/{id} - Delete Invitation

Delete the invitation.

Parameter Name Description Type Required? Parameter Type
id Invitation Id integer true path


Code Message Response
200 Ok
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/invitations/168333

Response:
                  
{
  "api_version": "1.0",
  "result": "success"
}
                

Example:

URI: https://api.littlegreenlight.com/api/v1/invitations/168334

Response:
                  
{
  "api_version": "1.0",
  "result": "success"
}
                



Keyword Management

GET /api/v1/categories/{category_id}/keywords - Fetch Keywords

Lists all the keywords.

Parameter Name Description Type Required? Parameter Type
category_id Category Id integer true path
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "category_id": 0,
      "name": "",
      "description": "",
      "short_code": "",
      "ordinal": 0,
      "removable": true,
      "can_change": true,
      "can_select": true,
      "created_at": "",
      "updated_at": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/categories/1042/keywords

Response:
                  
{
  "api_version": "1.0",
  "items_count": 2,
  "total_items": 2,
  "limit": 25,
  "offset": 0,
  "item_type": "keyword",
  "items": [
    {
      "id": 12223,
      "category_id": 1042,
      "name": "val1",
      "description": null,
      "short_code": null,
      "ordinal": 100,
      "removable": true,
      "can_change": true,
      "can_select": true,
      "created_at": "2023-09-18T20:20:40Z",
      "updated_at": "2023-09-18T20:20:40Z"
    },
    {
      "id": 12224,
      "category_id": 1042,
      "name": "val2",
      "description": null,
      "short_code": null,
      "ordinal": 100,
      "removable": true,
      "can_change": true,
      "can_select": true,
      "created_at": "2023-09-18T20:20:40Z",
      "updated_at": "2023-09-18T20:20:40Z"
    }
  ]
}
                



POST /api/v1/categories/{category_id}/keywords - Create new Keyword

Add keyword.

Parameter Name Description Type Required? Parameter Type
category_id Category Id integer true path
body Create Objects CreateBody true body

CreateBody

CreateBody {
category_id ( integer , required ): Category Id,
name ( string , required ): Name,
description ( string , optional ): Description,
short_code ( string , optional ): Short Code,
ordinal ( integer , optional ): Ordinal,
removable ( boolean , optional ): Removable?,
can_change ( boolean , optional ): Can Change?,
can_select ( boolean , optional ): Can Select?
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "category_id": 0,
  "name": "",
  "description": "",
  "short_code": "",
  "ordinal": 0,
  "removable": true,
  "can_change": true,
  "can_select": true,
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/categories/1042/keywords

Body:
                  
{
  "name": "New Keyword"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 12324,
  "category_id": 1042,
  "name": "New Keyword",
  "description": null,
  "short_code": null,
  "ordinal": 100,
  "removable": true,
  "can_change": true,
  "can_select": true,
  "created_at": "2024-02-06T15:58:27Z",
  "updated_at": "2024-02-06T15:58:27Z"
}
                

Example:

URI: https://api.littlegreenlight.com/api/v1/categories/1042/keywords

Body:
                  
{
  "name": "New Keyword 2"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 12325,
  "category_id": 1042,
  "name": "New Keyword 2",
  "description": null,
  "short_code": null,
  "ordinal": 100,
  "removable": true,
  "can_change": true,
  "can_select": true,
  "created_at": "2024-02-06T15:58:27Z",
  "updated_at": "2024-02-06T15:58:27Z"
}
                



POST /api/v1/constituents/{constituent_id}/keywords - Add Keyword

Add a keyword to a constituent.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
body Add Keyword AddBody true body

AddBody

AddBody {
id ( integer , required ): Keyword Id
}


Code Message Response
200 Ok
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/keywords

Body:
                  
{
  "id": "12325"
}
                


Response:
                  
{
  "api_version": "1.0",
  "result": "success"
}
                



DELETE /api/v1/constituents/{constituent_id}/keywords/{id} - Remove Keyword

Remove a keyword from a constituent

Parameter Name Description Type Required? Parameter Type
id Keyword Id integer true path
constituent_id Constituent Id integer true path


Code Message Response
200 Ok
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/keywords/12325

Response:
                  
{
  "api_version": "1.0",
  "result": "success"
}
                



GET /api/v1/keywords/{id} - Show Keyword details

Show details for the keyword.

Parameter Name Description Type Required? Parameter Type
id Keyword Id integer true path


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "category_id": 0,
  "name": "",
  "description": "",
  "short_code": "",
  "ordinal": 0,
  "removable": true,
  "can_change": true,
  "can_select": true,
  "created_at": "",
  "updated_at": ""
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/keywords/12225

Response:
                  
{
  "api_version": "1.0",
  "id": 12225,
  "category_id": 1039,
  "name": "New Tag",
  "description": null,
  "short_code": null,
  "ordinal": 100,
  "removable": true,
  "can_change": true,
  "can_select": true,
  "created_at": "2023-09-18T20:48:13Z",
  "updated_at": "2023-09-18T20:48:13Z"
}
                



PATCH /api/v1/keywords/{id} - Update Keyword

Update the keyword.

Parameter Name Description Type Required? Parameter Type
id Keyword Id integer true path
body Update Objects UpdateBody true body

UpdateBody

UpdateBody {
category_id ( integer , required ): Category Id,
name ( string , required ): Name,
description ( string , optional ): Description,
short_code ( string , optional ): Short Code,
ordinal ( integer , optional ): Ordinal,
removable ( boolean , optional ): Removable?,
can_change ( boolean , optional ): Can Change?,
can_select ( boolean , optional ): Can Select?
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "category_id": 0,
  "name": "",
  "description": "",
  "short_code": "",
  "ordinal": 0,
  "removable": true,
  "can_change": true,
  "can_select": true,
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/keywords/12324

Body:
                  
{
  "short_code": "new_keyword"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 12324,
  "category_id": 1042,
  "name": "New Keyword",
  "description": null,
  "short_code": "new_keyword",
  "ordinal": 100,
  "removable": true,
  "can_change": true,
  "can_select": true,
  "created_at": "2024-02-06T15:58:27Z",
  "updated_at": "2024-02-06T15:58:28Z"
}
                



DELETE /api/v1/keywords/{id} - Delete Keyword

Delete the keyword.

Parameter Name Description Type Required? Parameter Type
id Keyword Id integer true path
permanent Delete permantently. Default: 0 integer query


Code Message Response
200 Ok
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/keywords/12324

Response:
                  
{
  "api_version": "1.0",
  "result": "success"
}
                

Example:

URI: https://api.littlegreenlight.com/api/v1/keywords/12324

Query:
permanent=1


Response:
                  
{
  "api_version": "1.0",
  "result": "success"
}
                

Example:

URI: https://api.littlegreenlight.com/api/v1/keywords/12325

Query:
permanent=1


Response:
                  
{
  "api_version": "1.0",
  "result": "success"
}
                



Mailing Templates Management

GET /api/v1/mailing_templates - Fetch Mailing Templates

Lists all the mailing templates.

Parameter Name Description Type Required? Parameter Type
mailing_type_id Mailing type ID string query
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "name": "",
      "code": true,
      "mailing_type_id": 0,
      "mailing_type_name": "",
      "template_type": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/mailing_templates

Query:
mailing_type_id=1907&limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 2,
  "total_items": 2,
  "limit": 5,
  "offset": 0,
  "item_type": "mailing_template",
  "items": [
    {
      "id": 174,
      "name": "Donation Acknowledgment",
      "code": "donation_ack",
      "mailing_type_id": 1907,
      "mailing_type_name": "Acknowledgment",
      "template_type": "letter"
    },
    {
      "id": 175,
      "name": "Pledge Acknowledgment",
      "code": "pledge_ack",
      "mailing_type_id": 1907,
      "mailing_type_name": "Acknowledgment",
      "template_type": "letter"
    }
  ]
}
                



Membership Levels Management

GET /api/v1/membership_levels - Fetch Membership Levels

Lists all the membership levels.

Parameter Name Description Type Required? Parameter Type
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "name": "",
      "ordinal": 0
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/membership_levels

Response:
                  
{
  "api_version": "1.0",
  "items_count": 6,
  "total_items": 6,
  "limit": 25,
  "offset": 0,
  "item_type": "membership_level",
  "items": [
    {
      "id": 386,
      "name": "General",
      "ordinal": 0
    },
    {
      "id": 387,
      "name": "Friend",
      "ordinal": 1
    },
    {
      "id": 388,
      "name": "Gold",
      "ordinal": 100
    },
    {
      "id": 389,
      "name": "Silver",
      "ordinal": 100
    },
    {
      "id": 390,
      "name": "Diamond",
      "ordinal": 100
    },
    {
      "id": 391,
      "name": "Bronze",
      "ordinal": 100
    }
  ]
}
                



POST /api/v1/membership_levels - Create new Membership Level

Add membership level.

Parameter Name Description Type Required? Parameter Type
body Create Objects CreateBody true body

CreateBody

CreateBody {
name ( string , required ): Name,
ordinal ( integer , optional ): Ordinal
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "name": "",
  "ordinal": 0
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/membership_levels

Body:
                  
{
  "name": "Super Star",
  "ordinal": "1000"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 437,
  "name": "Super Star",
  "ordinal": 1000
}
                



GET /api/v1/membership_levels/{id} - Show Membership Level details

Show details for the membership level.

Parameter Name Description Type Required? Parameter Type
id Membership Level Id integer true path


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "name": "",
  "ordinal": 0
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/membership_levels/437

Response:
                  
{
  "api_version": "1.0",
  "id": 437,
  "name": "Super Star",
  "ordinal": 1000
}
                



PATCH /api/v1/membership_levels/{id} - Update Membership Level

Update the membership level.

Parameter Name Description Type Required? Parameter Type
id Membership Level Id integer true path
body Update Objects UpdateBody true body

UpdateBody

UpdateBody {
name ( string , required ): Name,
ordinal ( integer , optional ): Ordinal
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "name": "",
  "ordinal": 0
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/membership_levels/437

Body:
                  
{
  "name": "Super Luminal"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 437,
  "name": "Super Luminal",
  "ordinal": 1000
}
                



DELETE /api/v1/membership_levels/{id} - Delete Membership Level

Delete the membership level.

Parameter Name Description Type Required? Parameter Type
id Membership Level Id integer true path


Code Message Response
200 Ok
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/membership_levels/437

Response:
                  
{
  "api_version": "1.0",
  "result": "success"
}
                



Membership Management

GET /api/v1/constituents/{constituent_id}/memberships - Fetch Memberships

Lists all the memberships.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "constituent_id": 0,
      "membership_level_id": 0,
      "membership_level_name": "",
      "date_start": "",
      "finish_date": "",
      "note": "",
      "created_at": "",
      "updated_at": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/memberships

Response:
                  
{
  "api_version": "1.0",
  "items_count": 1,
  "total_items": 1,
  "limit": 25,
  "offset": 0,
  "item_type": "membership",
  "items": [
    {
      "id": 424,
      "constituent_id": 959480,
      "membership_level_id": 388,
      "membership_level_name": "Gold",
      "date_start": "2022-09-18",
      "finish_date": "2023-09-18",
      "note": null,
      "created_at": "2023-09-18T18:25:01Z",
      "updated_at": "2023-12-01T17:12:16Z"
    }
  ]
}
                



POST /api/v1/constituents/{constituent_id}/memberships - Create new Membership

Add membership.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
body Create Objects CreateBody true body

CreateBody

CreateBody {
membership_level_id ( integer , optional ): Membership Level ID,
membership_level_name ( string , optional ): Membership Level Name,
date_start ( date , optional ): Date start,
finish_date ( date , optional ): Date end,
note ( string , optional ): Note
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "membership_level_id": 0,
  "membership_level_name": "",
  "date_start": "",
  "finish_date": "",
  "note": "",
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/memberships

Body:
                  
{
  "membership_level_name": "Gold",
  "date_start": "2012-01-01",
  "finish_date": "2024-01-01"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 473,
  "constituent_id": 959480,
  "membership_level_id": 388,
  "membership_level_name": "Gold",
  "date_start": "2012-01-01",
  "finish_date": "2024-01-01",
  "note": null,
  "created_at": "2024-02-06T15:58:30Z",
  "updated_at": "2024-02-06T15:58:30Z"
}
                



GET /api/v1/memberships/{id} - Show Membership details

Show details for the membership.

Parameter Name Description Type Required? Parameter Type
id Membership Id integer true path


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "membership_level_id": 0,
  "membership_level_name": "",
  "date_start": "",
  "finish_date": "",
  "note": "",
  "created_at": "",
  "updated_at": ""
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/memberships/473

Response:
                  
{
  "api_version": "1.0",
  "id": 473,
  "constituent_id": 959480,
  "membership_level_id": 388,
  "membership_level_name": "Gold",
  "date_start": "2012-01-01",
  "finish_date": "2024-01-01",
  "note": null,
  "created_at": "2024-02-06T15:58:30Z",
  "updated_at": "2024-02-06T15:58:30Z"
}
                



PATCH /api/v1/memberships/{id} - Update Membership

Update the membership.

Parameter Name Description Type Required? Parameter Type
id Membership Id integer true path
body Update Objects UpdateBody true body

UpdateBody

UpdateBody {
membership_level_id ( integer , optional ): Membership Level ID,
membership_level_name ( string , optional ): Membership Level Name,
date_start ( date , optional ): Date start,
finish_date ( date , optional ): Date end,
note ( string , optional ): Note
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "membership_level_id": 0,
  "membership_level_name": "",
  "date_start": "",
  "finish_date": "",
  "note": "",
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/memberships/473

Body:
                  
{
  "membership_level_name": "Silver"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 473,
  "constituent_id": 959480,
  "membership_level_id": 389,
  "membership_level_name": "Silver",
  "date_start": "2012-01-01",
  "finish_date": "2024-01-01",
  "note": null,
  "created_at": "2024-02-06T15:58:30Z",
  "updated_at": "2024-02-06T15:58:31Z"
}
                



DELETE /api/v1/memberships/{id} - Delete Membership

Delete the membership.

Parameter Name Description Type Required? Parameter Type
id Membership Id integer true path


Code Message Response
200 Ok
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/memberships/473

Response:
                  
{
  "api_version": "1.0",
  "result": "success"
}
                



Payment Types Management

GET /api/v1/payment_types - Fetch Payment Types

Lists all the payment types.

Parameter Name Description Type Required? Parameter Type
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "name": "",
      "key": 0,
      "ordinal": 0
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/payment_types

Query:
limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 4,
  "total_items": 4,
  "limit": 5,
  "offset": 0,
  "item_type": "payment_type",
  "items": [
    {
      "id": 1507,
      "name": "Cash",
      "key": "cash",
      "ordinal": 0
    },
    {
      "id": 1508,
      "name": "Check",
      "key": "check",
      "ordinal": 1
    },
    {
      "id": 1509,
      "name": "Credit Card",
      "key": "credit",
      "ordinal": 2
    },
    {
      "id": 1510,
      "name": "Stock",
      "key": "stock",
      "ordinal": 3
    }
  ]
}
                



Phone Number Management

GET /api/v1/constituents/{constituent_id}/phone_numbers - Fetch Phone Numbers

Lists all the phone numbers.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "item_id": 0,
      "item_type": "",
      "number": "",
      "phone_number_type_id": 1,
      "phone_type_name": "Home",
      "is_preferred": true,
      "not_current": true,
      "created_at": "",
      "updated_at": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/phone_numbers

Response:
                  
{
  "api_version": "1.0",
  "items_count": 1,
  "total_items": 1,
  "limit": 25,
  "offset": 0,
  "item_type": "phone_number",
  "items": [
    {
      "id": 479627,
      "item_id": 959480,
      "item_type": "Constituent",
      "number": "(888) 555-0044",
      "phone_number_type_id": 3,
      "phone_type_name": "Mobile",
      "is_preferred": true,
      "not_current": false,
      "parent_id": null,
      "normalized_number": "8885550044",
      "created_at": "2023-09-18T18:25:01Z",
      "updated_at": "2023-09-19T22:34:56Z"
    }
  ]
}
                



POST /api/v1/constituents/{constituent_id}/phone_numbers - Create new Phone Number

Add phone number.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
body Create Objects CreateBody true body

CreateBody

CreateBody {
number ( string , optional ): Phone Number,
phone_number_type_id ( integer , optional ): Phone Number Type Id,
phone_type_name ( string , optional ): Phone Number Type Name,
is_preferred ( boolean , optional ): Make this the preferred phone number,
not_current ( boolean , optional ): No longer a current phone number
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "item_id": 0,
  "item_type": "",
  "number": "",
  "phone_number_type_id": 1,
  "phone_type_name": "Home",
  "is_preferred": true,
  "not_current": true,
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/phone_numbers

Body:
                  
{
  "number": "222-555-1212"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 479713,
  "item_id": 959480,
  "item_type": "Constituent",
  "number": "222-555-1212",
  "phone_number_type_id": 1,
  "phone_type_name": "Home",
  "is_preferred": false,
  "not_current": false,
  "parent_id": null,
  "normalized_number": "2225551212",
  "created_at": "2024-02-06T15:58:32Z",
  "updated_at": "2024-02-06T15:58:32Z"
}
                



GET /api/v1/phone_numbers/{id} - Show Phone Number details

Show details for the phone number.

Parameter Name Description Type Required? Parameter Type
id Phone Number Id integer true path


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "item_id": 0,
  "item_type": "",
  "number": "",
  "phone_number_type_id": 1,
  "phone_type_name": "Home",
  "is_preferred": true,
  "not_current": true,
  "created_at": "",
  "updated_at": ""
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/phone_numbers/479713

Response:
                  
{
  "api_version": "1.0",
  "id": 479713,
  "item_id": 959480,
  "item_type": "Constituent",
  "number": "222-555-1212",
  "phone_number_type_id": 1,
  "phone_type_name": "Home",
  "is_preferred": false,
  "not_current": false,
  "parent_id": null,
  "normalized_number": "2225551212",
  "created_at": "2024-02-06T15:58:32Z",
  "updated_at": "2024-02-06T15:58:32Z"
}
                



PATCH /api/v1/phone_numbers/{id} - Update Phone Number

Update the phone number.

Parameter Name Description Type Required? Parameter Type
id Phone Number Id integer true path
body Update Objects UpdateBody true body

UpdateBody

UpdateBody {
number ( string , optional ): Phone Number,
phone_number_type_id ( integer , optional ): Phone Number Type Id,
phone_type_name ( string , optional ): Phone Number Type Name,
is_preferred ( boolean , optional ): Make this the preferred phone number,
not_current ( boolean , optional ): No longer a current phone number
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "item_id": 0,
  "item_type": "",
  "number": "",
  "phone_number_type_id": 1,
  "phone_type_name": "Home",
  "is_preferred": true,
  "not_current": true,
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/phone_numbers/479713

Body:
                  
{
  "phone_number_type_id": 2
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 479713,
  "item_id": 959480,
  "item_type": "Constituent",
  "number": "222-555-1212",
  "phone_number_type_id": 2,
  "phone_type_name": "Work",
  "is_preferred": false,
  "not_current": false,
  "parent_id": null,
  "normalized_number": "2225551212",
  "created_at": "2024-02-06T15:58:32Z",
  "updated_at": "2024-02-06T15:58:32Z"
}
                



DELETE /api/v1/phone_numbers/{id} - Delete Phone Number

Delete the phone number.

Parameter Name Description Type Required? Parameter Type
id Phone Number Id integer true path


Code Message Response
200 Ok
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/phone_numbers/479713

Response:
                  
{
  "api_version": "1.0",
  "result": "success"
}
                



Street Address Management

GET /api/v1/constituents/{constituent_id}/street_addresses - Fetch Street Addresses

Lists all the street addresses.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "item_id": 0,
      "item_type": "",
      "street": "",
      "city": "",
      "state": "",
      "country": "",
      "postal_code": "",
      "county": "",
      "street_address_type_id": 1,
      "street_type_name": "Home",
      "is_preferred": true,
      "not_current": true,
      "seasonal_from": "01-01",
      "seasonal_to": "12-31",
      "seasonal": true,
      "lat": "",
      "lng": "",
      "zip5": "",
      "verified": true,
      "verified_on": "",
      "created_at": "",
      "updated_at": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/street_addresses

Response:
                  
{
  "api_version": "1.0",
  "items_count": 1,
  "total_items": 1,
  "limit": 25,
  "offset": 0,
  "item_type": "street_address",
  "items": [
    {
      "id": 838379,
      "item_id": 959480,
      "item_type": "Constituent",
      "street": "711 Calhoun Street",
      "city": "Chicago",
      "state": "IL",
      "country": "US",
      "postal_code": "60603",
      "county": "",
      "street_address_type_id": 1,
      "street_type_name": "Home",
      "is_preferred": true,
      "not_current": false,
      "parent_id": null,
      "seasonal_from": "01-01",
      "seasonal_to": "12-31",
      "seasonal": null,
      "lat": null,
      "lng": null,
      "zip5": "60603",
      "verified": false,
      "verified_on": null,
      "created_at": "2023-09-18T18:25:01Z",
      "updated_at": "2023-09-19T22:34:56Z"
    }
  ]
}
                



POST /api/v1/constituents/{constituent_id}/street_addresses - Create new Street Address

Add street address.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
body Create Objects CreateBody true body

CreateBody

CreateBody {
street ( string , optional ): Street,
street_address_type_id ( integer , optional ): Street Address Type ID,
street_type_name ( string , optional ): Street Address Type Name,
city ( string , optional ): City,
state ( string , optional ): State/Province,
postal_code ( string , optional ): Zip/Postal Code,
county ( string , optional ): County,
country ( string , optional ): Country,
seasonal_from ( string , optional ): Seasonal from (mm-dd),
seasonal_to ( string , optional ): Seasonal to (mm-dd),
seasonal ( boolean , optional ): Is seasonal?,
is_preferred ( boolean , optional ): Is preferred address,
not_current ( boolean , optional ): Not current?
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "item_id": 0,
  "item_type": "",
  "street": "",
  "city": "",
  "state": "",
  "country": "",
  "postal_code": "",
  "county": "",
  "street_address_type_id": 1,
  "street_type_name": "Home",
  "is_preferred": true,
  "not_current": true,
  "seasonal_from": "01-01",
  "seasonal_to": "12-31",
  "seasonal": true,
  "lat": "",
  "lng": "",
  "zip5": "",
  "verified": true,
  "verified_on": "",
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/street_addresses

Body:
                  
{
  "street": "123 SE Tree",
  "city": "Seattle",
  "state": "WA",
  "postal_code": "98101"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 838511,
  "item_id": 959480,
  "item_type": "Constituent",
  "street": "123 SE Tree",
  "city": "Seattle",
  "state": "WA",
  "country": null,
  "postal_code": "98101",
  "county": null,
  "street_address_type_id": 1,
  "street_type_name": "Home",
  "is_preferred": false,
  "not_current": false,
  "parent_id": null,
  "seasonal_from": "01-01",
  "seasonal_to": "12-31",
  "seasonal": null,
  "lat": null,
  "lng": null,
  "zip5": "98101",
  "verified": false,
  "verified_on": null,
  "created_at": "2024-02-06T15:58:33Z",
  "updated_at": "2024-02-06T15:58:33Z"
}
                



GET /api/v1/street_addresses/{id} - Show Street Address details

Show details for the street address.

Parameter Name Description Type Required? Parameter Type
id Street Address Id integer true path


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "item_id": 0,
  "item_type": "",
  "street": "",
  "city": "",
  "state": "",
  "country": "",
  "postal_code": "",
  "county": "",
  "street_address_type_id": 1,
  "street_type_name": "Home",
  "is_preferred": true,
  "not_current": true,
  "seasonal_from": "01-01",
  "seasonal_to": "12-31",
  "seasonal": true,
  "lat": "",
  "lng": "",
  "zip5": "",
  "verified": true,
  "verified_on": "",
  "created_at": "",
  "updated_at": ""
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/street_addresses/838511

Response:
                  
{
  "api_version": "1.0",
  "id": 838511,
  "item_id": 959480,
  "item_type": "Constituent",
  "street": "123 SE Tree",
  "city": "Seattle",
  "state": "WA",
  "country": null,
  "postal_code": "98101",
  "county": null,
  "street_address_type_id": 1,
  "street_type_name": "Home",
  "is_preferred": false,
  "not_current": false,
  "parent_id": null,
  "seasonal_from": "01-01",
  "seasonal_to": "12-31",
  "seasonal": null,
  "lat": null,
  "lng": null,
  "zip5": "98101",
  "verified": false,
  "verified_on": null,
  "created_at": "2024-02-06T15:58:33Z",
  "updated_at": "2024-02-06T15:58:33Z"
}
                



PATCH /api/v1/street_addresses/{id} - Update Street Address

Update the street address.

Parameter Name Description Type Required? Parameter Type
id Street Address Id integer true path
body Update Objects UpdateBody true body

UpdateBody

UpdateBody {
street ( string , optional ): Street,
street_address_type_id ( integer , optional ): Street Address Type ID,
street_type_name ( string , optional ): Street Address Type Name,
city ( string , optional ): City,
state ( string , optional ): State/Province,
postal_code ( string , optional ): Zip/Postal Code,
county ( string , optional ): County,
country ( string , optional ): Country,
seasonal_from ( string , optional ): Seasonal from (mm-dd),
seasonal_to ( string , optional ): Seasonal to (mm-dd),
seasonal ( boolean , optional ): Is seasonal?,
is_preferred ( boolean , optional ): Is preferred address,
not_current ( boolean , optional ): Not current?
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "item_id": 0,
  "item_type": "",
  "street": "",
  "city": "",
  "state": "",
  "country": "",
  "postal_code": "",
  "county": "",
  "street_address_type_id": 1,
  "street_type_name": "Home",
  "is_preferred": true,
  "not_current": true,
  "seasonal_from": "01-01",
  "seasonal_to": "12-31",
  "seasonal": true,
  "lat": "",
  "lng": "",
  "zip5": "",
  "verified": true,
  "verified_on": "",
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/street_addresses/838511

Body:
                  
{
  "street_address_type_id": 2
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 838511,
  "item_id": 959480,
  "item_type": "Constituent",
  "street": "123 SE Tree",
  "city": "Seattle",
  "state": "WA",
  "country": null,
  "postal_code": "98101",
  "county": null,
  "street_address_type_id": 2,
  "street_type_name": "Work",
  "is_preferred": false,
  "not_current": false,
  "parent_id": null,
  "seasonal_from": "01-01",
  "seasonal_to": "12-31",
  "seasonal": null,
  "lat": null,
  "lng": null,
  "zip5": "98101",
  "verified": false,
  "verified_on": null,
  "created_at": "2024-02-06T15:58:33Z",
  "updated_at": "2024-02-06T15:58:34Z"
}
                



DELETE /api/v1/street_addresses/{id} - Delete Street Address

Delete the street address.

Parameter Name Description Type Required? Parameter Type
id Street Address Id integer true path


Code Message Response
200 Ok
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/street_addresses/838511

Response:
                  
{
  "api_version": "1.0",
  "result": "success"
}
                



Team Members Management

GET /api/v1/team_members - Fetch Team Members

Lists all the team members.

Parameter Name Description Type Required? Parameter Type
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "first_name": "",
      "last_name": "",
      "email": "",
      "role_id": 0,
      "is_primary_contact": true,
      "is_billing_contact": true
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/team_members

Query:
limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 2,
  "total_items": 2,
  "limit": 5,
  "offset": 0,
  "item_type": "team_member",
  "items": [
    {
      "id": 1047033,
      "first_name": "Tom",
      "last_name": "Talbott",
      "email": "team_member@example.com",
      "role_id": 406638,
      "is_admin": true,
      "is_primary_contact": true,
      "is_billing_contact": true
    },
    {
      "id": 1047042,
      "first_name": "Nick",
      "last_name": "Bicknell",
      "email": "team_member@example.com",
      "role_id": 406638,
      "is_admin": true,
      "is_primary_contact": false,
      "is_billing_contact": false
    }
  ]
}
                



Type Management

GET /api/v1/types - Fetch Types for Account

Lists all the types for an account.

Parameter Name Description Type Required? Parameter Type
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "name": "",
      "key": "",
      "values": [
        {
          "id": 0,
          "name": "",
          "display_name": "",
          "code": "",
          "ordinal": 0
        }
      ]
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/types

Response:
                  
{
  "api_version": "1.0",
  "items_count": 9,
  "total_items": 9,
  "limit": 25,
  "offset": 0,
  "item_type": "type",
  "items": [
    {
      "name": "Contact Report Types",
      "key": "contact_report_types",
      "values": [
        {
          "id": 2183,
          "name": "Call",
          "display_name": "Call",
          "code": "call",
          "ordinal": 0
        },
        {
          "id": 2184,
          "name": "Email",
          "display_name": "Email",
          "code": "email",
          "ordinal": 1
        },
        {
          "id": 2185,
          "name": "Meeting",
          "display_name": "Meeting",
          "code": "meeting",
          "ordinal": 2
        },
        {
          "id": 2186,
          "name": "Mailing",
          "display_name": "Mailing",
          "code": "letter",
          "ordinal": 3
        },
        {
          "id": 2187,
          "name": "Proposal",
          "display_name": "Proposal",
          "code": "proposal",
          "ordinal": 4
        },
        {
          "id": 2188,
          "name": "Other",
          "display_name": "Other",
          "code": "other",
          "ordinal": 5
        }
      ]
    },
    {
      "name": "Email Address Types",
      "key": "email_address_types",
      "values": [
        {
          "id": 1,
          "name": "Home",
          "display_name": "Home",
          "code": "home",
          "ordinal": 100
        },
        {
          "id": 2,
          "name": "Work",
          "display_name": "Work",
          "code": "work",
          "ordinal": 100
        },
        {
          "id": 3,
          "name": "Other",
          "display_name": "Other",
          "code": "other",
          "ordinal": 100
        },
        {
          "id": 4,
          "name": "Assistant",
          "display_name": "Assistant",
          "code": "assistant",
          "ordinal": 101
        }
      ]
    },
    {
      "name": "Mailing Types",
      "key": "mailing_types",
      "values": [
        {
          "id": 1907,
          "name": "Acknowledgment",
          "display_name": "Acknowledgment",
          "code": "acknowledgment",
          "ordinal": 0
        },
        {
          "id": 1908,
          "name": "Reminder",
          "display_name": "Reminder",
          "code": "reminder",
          "ordinal": 1
        },
        {
          "id": 1909,
          "name": "Appeal",
          "display_name": "Appeal",
          "code": "appeal",
          "ordinal": 2
        },
        {
          "id": 1910,
          "name": "Newsletter",
          "display_name": "Newsletter",
          "code": "newsletter",
          "ordinal": 3
        },
        {
          "id": 1911,
          "name": "Other",
          "display_name": "Other",
          "code": "other",
          "ordinal": 4
        },
        {
          "id": 1912,
          "name": "Invitation",
          "display_name": "Invitation",
          "code": "invitation",
          "ordinal": 5
        },
        {
          "id": 1913,
          "name": "Honorary",
          "display_name": "Honorary",
          "code": "honorary",
          "ordinal": 6
        },
        {
          "id": 1914,
          "name": "Memorial",
          "display_name": "Memorial",
          "code": "memorial",
          "ordinal": 7
        },
        {
          "id": 1915,
          "name": "Annual Statement",
          "display_name": "Annual Statement",
          "code": "annual_statement",
          "ordinal": 8
        }
      ]
    },
    {
      "name": "Street Address Types",
      "key": "street_address_types",
      "values": [
        {
          "id": 1,
          "name": "Home",
          "display_name": "Home",
          "code": "home",
          "ordinal": 100
        },
        {
          "id": 2,
          "name": "Work",
          "display_name": "Work",
          "code": "work",
          "ordinal": 100
        },
        {
          "id": 3,
          "name": "Other",
          "display_name": "Other",
          "code": "other",
          "ordinal": 100
        },
        {
          "id": 4,
          "name": "School",
          "display_name": "School",
          "code": "school",
          "ordinal": 100
        }
      ]
    },
    {
      "name": "Phone Number Types",
      "key": "phone_number_types",
      "values": [
        {
          "id": 1,
          "name": "Home",
          "display_name": "Home",
          "code": "home",
          "ordinal": 100
        },
        {
          "id": 2,
          "name": "Work",
          "display_name": "Work",
          "code": "work",
          "ordinal": 100
        },
        {
          "id": 3,
          "name": "Mobile",
          "display_name": "Mobile",
          "code": "mobile",
          "ordinal": 100
        },
        {
          "id": 4,
          "name": "Other",
          "display_name": "Other",
          "code": "other",
          "ordinal": 100
        },
        {
          "id": 6,
          "name": "Skype",
          "display_name": "Skype",
          "code": "skype",
          "ordinal": 100
        },
        {
          "id": 5,
          "name": "Fax",
          "display_name": "Fax",
          "code": "fax",
          "ordinal": 101
        },
        {
          "id": 7,
          "name": "Assistant",
          "display_name": "Assistant",
          "code": "assistant",
          "ordinal": 101
        },
        {
          "id": 8,
          "name": "Pager",
          "display_name": "Pager",
          "code": "pager",
          "ordinal": 102
        }
      ]
    },
    {
      "name": "Web Address Types",
      "key": "web_address_types",
      "values": [
        {
          "id": 5,
          "name": "Website",
          "display_name": "Website",
          "code": "website",
          "ordinal": 0
        },
        {
          "id": 6,
          "name": "Facebook",
          "display_name": "Facebook",
          "code": "facebook",
          "ordinal": 1
        },
        {
          "id": 7,
          "name": "Twitter",
          "display_name": "Twitter",
          "code": "twitter",
          "ordinal": 2
        },
        {
          "id": 8,
          "name": "LinkedIn",
          "display_name": "LinkedIn",
          "code": "linkedin",
          "ordinal": 3
        }
      ]
    },
    {
      "name": "Volunteering Categories",
      "key": "volunteering_categories",
      "values": [
        {
          "id": 446,
          "name": "General",
          "display_name": "General",
          "code": "general",
          "ordinal": 0
        },
        {
          "id": 447,
          "name": "Donor Management",
          "display_name": "Donor Management",
          "code": "donor_management",
          "ordinal": 100
        }
      ]
    },
    {
      "name": "Appeal Types",
      "key": "appeal_types",
      "values": [

      ]
    },
    {
      "name": "Event Types",
      "key": "event_types",
      "values": [

      ]
    }
  ]
}
                



GET /api/v1/types/{type} - Fetch Values for Type

Lists all the values for a type.

Parameter Name Description Type Required? Parameter Type
type Type: [ contact_report_types | email_address_types | mailing_types | street_address_types | phone_number_types | web_address_types | volunteering_categories | appeal_types | event_types ] string true path
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "name": "",
      "display_name": "",
      "code": "",
      "ordinal": 0
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/types/email_address_types

Response:
                  
{
  "api_version": "1.0",
  "items_count": 4,
  "total_items": 4,
  "limit": 25,
  "offset": 0,
  "item_type": "email_address_type",
  "items": [
    {
      "id": 1,
      "name": "Home",
      "display_name": "Home",
      "code": "home",
      "ordinal": 100
    },
    {
      "id": 2,
      "name": "Work",
      "display_name": "Work",
      "code": "work",
      "ordinal": 100
    },
    {
      "id": 3,
      "name": "Other",
      "display_name": "Other",
      "code": "other",
      "ordinal": 100
    },
    {
      "id": 4,
      "name": "Assistant",
      "display_name": "Assistant",
      "code": "assistant",
      "ordinal": 101
    }
  ]
}
                



Volunteer Time Management

GET /api/v1/constituents/{constituent_id}/volunteer_times - Fetch Volunteer Times for Constituent

Lists all the volunteer times for a constituent.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "constituent_id": 0,
      "external_id": 0,
      "volunteering_category_id": 0,
      "volunteering_category_name": "",
      "description": "",
      "hours": 0,
      "date": "",
      "end_date": "",
      "completed_hours": 0,
      "custom_fields": [
        {
          "id": 0,
          "item_type": "",
          "name": "",
          "key": "",
          "facet_type": "",
          "ordinal": 0,
          "removable": true,
          "editable": true,
          "values": [
            {
              "category_id": 0,
              "name": "",
              "description": "",
              "short_code": "",
              "ordinal": 0,
              "removable": true,
              "can_change": true,
              "can_select": true
            }
          ]
        }
      ],
      "created_at": "",
      "updated_at": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/volunteer_times

Response:
                  
{
  "api_version": "1.0",
  "items_count": 2,
  "total_items": 2,
  "limit": 25,
  "offset": 0,
  "item_type": "volunteer_time",
  "items": [
    {
      "id": 2981,
      "constituent_id": 959480,
      "external_id": null,
      "volunteering_category_id": 447,
      "volunteering_category_name": "Donor Management",
      "description": "",
      "hours": 4.0,
      "date": "2023-09-19",
      "end_date": "2023-09-19",
      "completed_hours": null,
      "custom_fields": [

      ],
      "created_at": "2023-09-19T22:07:01Z",
      "updated_at": "2023-09-19T22:07:01Z"
    },
    {
      "id": 3001,
      "constituent_id": 959480,
      "external_id": null,
      "volunteering_category_id": 446,
      "volunteering_category_name": "General",
      "description": "Donor management",
      "hours": 4.0,
      "date": "2018-01-02",
      "end_date": "2018-01-12",
      "completed_hours": 4.0,
      "custom_fields": [

      ],
      "created_at": "2023-11-15T22:04:55Z",
      "updated_at": "2023-11-15T22:04:56Z"
    }
  ]
}
                



POST /api/v1/constituents/{constituent_id}/volunteer_times - Create new Volunteer Time

Add volunteer time.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
body Create Objects CreateBody true body

CreateBody

CreateBody {
constituent_id ( integer , required ): Constituent ID,
external_id ( integer , optional ): External Volunteering ID,
volunteering_category_id ( integer , required ): Volunteer Category Id,
volunteering_category_name ( string , optional ): Volunteer Category Name,
description ( string , optional ): Description,
hours ( double , optional ): Hours,
date ( date , optional ): Date,
end_date ( date , optional ): End Date,
completed_hours ( double , optional ): Completed Hours,
custom_fields ( array , optional , CustomFieldAggregatedUpdate ): VolunteerTime custom fields (Categories)
}
CustomFieldAggregatedUpdate {
id ( integer , optional ): Custom Field Id,
name ( string , required ): Name,
key ( string , optional ): Key,
remove_previous_values ( boolean , optional ): Remove previous field values,
values ( array , required , CustomValueAggregatedUpdate ): Values
}
CustomValueAggregatedUpdate {
id ( integer , required ): Value Id,
name ( string , required ): Name
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "external_id": 0,
  "volunteering_category_id": 0,
  "volunteering_category_name": "",
  "description": "",
  "hours": 0,
  "date": "",
  "end_date": "",
  "completed_hours": 0,
  "custom_fields": [
    {
      "id": 0,
      "item_type": "",
      "name": "",
      "key": "",
      "facet_type": "",
      "ordinal": 0,
      "removable": true,
      "editable": true,
      "values": [
        {
          "category_id": 0,
          "name": "",
          "description": "",
          "short_code": "",
          "ordinal": 0,
          "removable": true,
          "can_change": true,
          "can_select": true
        }
      ]
    }
  ],
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/volunteer_times

Body:
                  
{
  "volunteering_category_name": "General",
  "description": "Donor management",
  "hours": "4",
  "date": "2018-01-02",
  "external_id": "678890"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 3007,
  "constituent_id": 959480,
  "external_id": "678890",
  "volunteering_category_id": 446,
  "volunteering_category_name": "General",
  "description": "Donor management",
  "hours": 4.0,
  "date": "2018-01-02",
  "end_date": null,
  "completed_hours": null,
  "custom_fields": [

  ],
  "created_at": "2024-02-06T15:58:35Z",
  "updated_at": "2024-02-06T15:58:35Z"
}
                



GET /api/v1/volunteer_times/search - Search for Volunteer Times

Search for active volunteer times

Parameter Name Description Type Required? Parameter Type
q[] Query String. (EX: updated_from=2016-01-01) string true query
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "constituent_id": 0,
      "external_id": 0,
      "volunteering_category_id": 0,
      "volunteering_category_name": "",
      "description": "",
      "hours": 0,
      "date": "",
      "end_date": "",
      "completed_hours": 0,
      "custom_fields": [
        {
          "id": 0,
          "item_type": "",
          "name": "",
          "key": "",
          "facet_type": "",
          "ordinal": 0,
          "removable": true,
          "editable": true,
          "values": [
            {
              "category_id": 0,
              "name": "",
              "description": "",
              "short_code": "",
              "ordinal": 0,
              "removable": true,
              "can_change": true,
              "can_select": true
            }
          ]
        }
      ],
      "created_at": "",
      "updated_at": ""
    }
  ]
}
                
400 Bad Request
401 Unauthorized
403 Forbidden

Available Search Terms:

Date date_from Date updated from (YYYY-MM-DDTHH:MM:SSZ)
date_to Date updated to (YYYY-MM-DDTHH:MM:SSZ)
Description description Description contains string
Volunteering Category volunteering_category_id Comma separated volunteering_category_ids
Constituent Id constituent_id Comma separated constituent_ids
Constituent Keyword const_keyword Comma separated Constituent keyword_ids
Updated At updated_from Date updated from (YYYY-MM-DDTHH:MM:SSZ)
updated_to Date updated to (YYYY-MM-DDTHH:MM:SSZ)

Note: Multiple terms may be combined using a semi-colon: "updated_from=2018-05-04;updated_to=2018-05-04"

Example - Search by Description:

URI: https://api.littlegreenlight.com/api/v1/volunteer_times/search

Query:
q[]=description=Donor management&limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 2,
  "total_items": 2,
  "limit": 5,
  "offset": 0,
  "item_type": "volunteer_time",
  "items": [
    {
      "id": 3007,
      "constituent_id": 959480,
      "external_id": "678890",
      "volunteering_category_id": 446,
      "volunteering_category_name": "General",
      "description": "Donor management",
      "hours": 4.0,
      "date": "2018-01-02",
      "end_date": null,
      "completed_hours": null,
      "custom_fields": [

      ],
      "created_at": "2024-02-06T15:58:35Z",
      "updated_at": "2024-02-06T15:58:35Z"
    },
    {
      "id": 3001,
      "constituent_id": 959480,
      "external_id": null,
      "volunteering_category_id": 446,
      "volunteering_category_name": "General",
      "description": "Donor management",
      "hours": 4.0,
      "date": "2018-01-02",
      "end_date": "2018-01-12",
      "completed_hours": 4.0,
      "custom_fields": [

      ],
      "created_at": "2023-11-15T22:04:55Z",
      "updated_at": "2023-11-15T22:04:56Z"
    }
  ]
}
                

Example - Search by Constituent Keyword ID and Updated Since:

URI: https://api.littlegreenlight.com/api/v1/volunteer_times/search

Query:
q[]=const_keyword=12221;updated_from=2016-01-01&limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 3,
  "total_items": 3,
  "limit": 5,
  "offset": 0,
  "item_type": "volunteer_time",
  "items": [
    {
      "id": 2981,
      "constituent_id": 959480,
      "external_id": null,
      "volunteering_category_id": 447,
      "volunteering_category_name": "Donor Management",
      "description": "",
      "hours": 4.0,
      "date": "2023-09-19",
      "end_date": "2023-09-19",
      "completed_hours": null,
      "custom_fields": [

      ],
      "created_at": "2023-09-19T22:07:01Z",
      "updated_at": "2023-09-19T22:07:01Z"
    },
    {
      "id": 3007,
      "constituent_id": 959480,
      "external_id": "678890",
      "volunteering_category_id": 446,
      "volunteering_category_name": "General",
      "description": "Donor management",
      "hours": 4.0,
      "date": "2018-01-02",
      "end_date": null,
      "completed_hours": null,
      "custom_fields": [

      ],
      "created_at": "2024-02-06T15:58:35Z",
      "updated_at": "2024-02-06T15:58:35Z"
    },
    {
      "id": 3001,
      "constituent_id": 959480,
      "external_id": null,
      "volunteering_category_id": 446,
      "volunteering_category_name": "General",
      "description": "Donor management",
      "hours": 4.0,
      "date": "2018-01-02",
      "end_date": "2018-01-12",
      "completed_hours": 4.0,
      "custom_fields": [

      ],
      "created_at": "2023-11-15T22:04:55Z",
      "updated_at": "2023-11-15T22:04:56Z"
    }
  ]
}
                



GET /api/v1/volunteer_times - Fetch Volunteer Times for Account

Lists all the volunteer times for an account.

Parameter Name Description Type Required? Parameter Type
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "constituent_id": 0,
      "external_id": 0,
      "volunteering_category_id": 0,
      "volunteering_category_name": "",
      "description": "",
      "hours": 0,
      "date": "",
      "end_date": "",
      "completed_hours": 0,
      "custom_fields": [
        {
          "id": 0,
          "item_type": "",
          "name": "",
          "key": "",
          "facet_type": "",
          "ordinal": 0,
          "removable": true,
          "editable": true,
          "values": [
            {
              "category_id": 0,
              "name": "",
              "description": "",
              "short_code": "",
              "ordinal": 0,
              "removable": true,
              "can_change": true,
              "can_select": true
            }
          ]
        }
      ],
      "created_at": "",
      "updated_at": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/volunteer_times

Query:
limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 4,
  "total_items": 4,
  "limit": 5,
  "offset": 0,
  "item_type": "volunteer_time",
  "items": [
    {
      "id": 2981,
      "constituent_id": 959480,
      "external_id": null,
      "volunteering_category_id": 447,
      "volunteering_category_name": "Donor Management",
      "description": "",
      "hours": 4.0,
      "date": "2023-09-19",
      "end_date": "2023-09-19",
      "completed_hours": null,
      "custom_fields": [

      ],
      "created_at": "2023-09-19T22:07:01Z",
      "updated_at": "2023-09-19T22:07:01Z"
    },
    {
      "id": 2982,
      "constituent_id": 959508,
      "external_id": null,
      "volunteering_category_id": 446,
      "volunteering_category_name": "General",
      "description": "",
      "hours": 5.0,
      "date": "2023-09-20",
      "end_date": "2023-09-20",
      "completed_hours": null,
      "custom_fields": [

      ],
      "created_at": "2023-09-19T22:08:07Z",
      "updated_at": "2023-09-19T22:08:07Z"
    },
    {
      "id": 3001,
      "constituent_id": 959480,
      "external_id": null,
      "volunteering_category_id": 446,
      "volunteering_category_name": "General",
      "description": "Donor management",
      "hours": 4.0,
      "date": "2018-01-02",
      "end_date": "2018-01-12",
      "completed_hours": 4.0,
      "custom_fields": [

      ],
      "created_at": "2023-11-15T22:04:55Z",
      "updated_at": "2023-11-15T22:04:56Z"
    },
    {
      "id": 3007,
      "constituent_id": 959480,
      "external_id": "678890",
      "volunteering_category_id": 446,
      "volunteering_category_name": "General",
      "description": "Donor management",
      "hours": 4.0,
      "date": "2018-01-02",
      "end_date": null,
      "completed_hours": null,
      "custom_fields": [

      ],
      "created_at": "2024-02-06T15:58:35Z",
      "updated_at": "2024-02-06T15:58:35Z"
    }
  ]
}
                



GET /api/v1/volunteer_times/{id} - Show Volunteer Time details

Show details for the volunteer time.

Parameter Name Description Type Required? Parameter Type
id Volunteer Time Id integer true path


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "external_id": 0,
  "volunteering_category_id": 0,
  "volunteering_category_name": "",
  "description": "",
  "hours": 0,
  "date": "",
  "end_date": "",
  "completed_hours": 0,
  "custom_fields": [
    {
      "id": 0,
      "item_type": "",
      "name": "",
      "key": "",
      "facet_type": "",
      "ordinal": 0,
      "removable": true,
      "editable": true,
      "values": [
        {
          "category_id": 0,
          "name": "",
          "description": "",
          "short_code": "",
          "ordinal": 0,
          "removable": true,
          "can_change": true,
          "can_select": true
        }
      ]
    }
  ],
  "created_at": "",
  "updated_at": ""
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/volunteer_times/3007

Response:
                  
{
  "api_version": "1.0",
  "id": 3007,
  "constituent_id": 959480,
  "external_id": "678890",
  "volunteering_category_id": 446,
  "volunteering_category_name": "General",
  "description": "Donor management",
  "hours": 4.0,
  "date": "2018-01-02",
  "end_date": null,
  "completed_hours": null,
  "custom_fields": [

  ],
  "created_at": "2024-02-06T15:58:35Z",
  "updated_at": "2024-02-06T15:58:35Z"
}
                



PATCH /api/v1/volunteer_times/{id} - Update Volunteer Time

Update the volunteer time.

Parameter Name Description Type Required? Parameter Type
id Volunteer Time Id integer true path
body Update Objects UpdateBody true body

UpdateBody

UpdateBody {
constituent_id ( integer , required ): Constituent ID,
external_id ( integer , optional ): External Volunteering ID,
volunteering_category_id ( integer , required ): Volunteer Category Id,
volunteering_category_name ( string , optional ): Volunteer Category Name,
description ( string , optional ): Description,
hours ( double , optional ): Hours,
date ( date , optional ): Date,
end_date ( date , optional ): End Date,
completed_hours ( double , optional ): Completed Hours,
custom_fields ( array , optional , CustomFieldAggregatedUpdate ): VolunteerTime custom fields (Categories)
}
CustomFieldAggregatedUpdate {
id ( integer , optional ): Custom Field Id,
name ( string , required ): Name,
key ( string , optional ): Key,
remove_previous_values ( boolean , optional ): Remove previous field values,
values ( array , required , CustomValueAggregatedUpdate ): Values
}
CustomValueAggregatedUpdate {
id ( integer , required ): Value Id,
name ( string , required ): Name
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "constituent_id": 0,
  "external_id": 0,
  "volunteering_category_id": 0,
  "volunteering_category_name": "",
  "description": "",
  "hours": 0,
  "date": "",
  "end_date": "",
  "completed_hours": 0,
  "custom_fields": [
    {
      "id": 0,
      "item_type": "",
      "name": "",
      "key": "",
      "facet_type": "",
      "ordinal": 0,
      "removable": true,
      "editable": true,
      "values": [
        {
          "category_id": 0,
          "name": "",
          "description": "",
          "short_code": "",
          "ordinal": 0,
          "removable": true,
          "can_change": true,
          "can_select": true
        }
      ]
    }
  ],
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/volunteer_times/3007

Body:
                  
{
  "end_date": "2018-01-12",
  "completed_hours": "4",
  "custom_fields": [
    {
      "name": "Sponsor",
      "values": [
        {
          "name": "LGL"
        }
      ]
    }
  ]
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 3007,
  "constituent_id": 959480,
  "external_id": "678890",
  "volunteering_category_id": 446,
  "volunteering_category_name": "General",
  "description": "Donor management",
  "hours": 4.0,
  "date": "2018-01-02",
  "end_date": "2018-01-12",
  "completed_hours": 4.0,
  "custom_fields": [

  ],
  "created_at": "2024-02-06T15:58:35Z",
  "updated_at": "2024-02-06T15:58:36Z"
}
                



DELETE /api/v1/volunteer_times/{id} - Delete Volunteer Time

Delete the volunteer time.

Parameter Name Description Type Required? Parameter Type
id Volunteer Time Id integer true path


Code Message Response
200 Ok
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/volunteer_times/3007

Response:
                  
{
  "api_version": "1.0",
  "result": "success"
}
                



Web Address Management

GET /api/v1/constituents/{constituent_id}/web_addresses - Fetch Web Addresses

Lists all the web addresses.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
limit Number of entries to return. Default: 25 integer query
offset Start at given entry. Default: 0 integer query


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "items_count": 0,
  "total_items": 0,
  "limit": 25,
  "offset": 0,
  "next_item": 0,
  "next_link": "",
  "item_type": "",
  "items": [
    {
      "id": 0,
      "item_id": 0,
      "item_type": "",
      "url": "",
      "web_address_type_id": 0,
      "web_address_type_name": "",
      "is_preferred": true,
      "created_at": "",
      "updated_at": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/web_addresses

Response:
                  
{
  "api_version": "1.0",
  "items_count": 2,
  "total_items": 2,
  "limit": 25,
  "offset": 0,
  "item_type": "web_address",
  "items": [
    {
      "id": 46,
      "item_id": 959480,
      "item_type": "Constituent",
      "url": "www.website.com",
      "web_address_type_id": 5,
      "web_address_type_name": "Website",
      "is_preferred": false,
      "parent_id": null,
      "created_at": "2023-09-19T22:34:56Z",
      "updated_at": "2023-09-19T22:34:56Z"
    },
    {
      "id": 47,
      "item_id": 959480,
      "item_type": "Constituent",
      "url": "facebook.com/something",
      "web_address_type_id": 6,
      "web_address_type_name": "Facebook",
      "is_preferred": false,
      "parent_id": null,
      "created_at": "2023-09-19T22:34:56Z",
      "updated_at": "2023-09-19T22:34:56Z"
    }
  ]
}
                



POST /api/v1/constituents/{constituent_id}/web_addresses - Create new Web Address

Add web address.

Parameter Name Description Type Required? Parameter Type
constituent_id Constituent Id integer true path
body Create Objects CreateBody true body

CreateBody

CreateBody {
url ( string , optional ): Web Address,
web_address_type_id ( integer , optional ): Web Address Type ID,
web_address_type_name ( string , optional ): Web Address Type Name,
is_preferred ( boolean , optional ): Make this the preferred email address
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "item_id": 0,
  "item_type": "",
  "url": "",
  "web_address_type_id": 0,
  "web_address_type_name": "",
  "is_preferred": true,
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/constituents/959480/web_addresses

Body:
                  
{
  "url": "www.example.com"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 69,
  "item_id": 959480,
  "item_type": "Constituent",
  "url": "www.example.com",
  "web_address_type_id": 5,
  "web_address_type_name": "Website",
  "is_preferred": false,
  "parent_id": null,
  "created_at": "2024-02-06T15:58:37Z",
  "updated_at": "2024-02-06T15:58:37Z"
}
                



GET /api/v1/web_addresses/{id} - Show Web Address details

Show details for the web address.

Parameter Name Description Type Required? Parameter Type
id Web Address Id integer true path


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "item_id": 0,
  "item_type": "",
  "url": "",
  "web_address_type_id": 0,
  "web_address_type_name": "",
  "is_preferred": true,
  "created_at": "",
  "updated_at": ""
}
                
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/web_addresses/69

Response:
                  
{
  "api_version": "1.0",
  "id": 69,
  "item_id": 959480,
  "item_type": "Constituent",
  "url": "www.example.com",
  "web_address_type_id": 5,
  "web_address_type_name": "Website",
  "is_preferred": false,
  "parent_id": null,
  "created_at": "2024-02-06T15:58:37Z",
  "updated_at": "2024-02-06T15:58:37Z"
}
                



PATCH /api/v1/web_addresses/{id} - Update Web Address

Update the web address.

Parameter Name Description Type Required? Parameter Type
id Web Address Id integer true path
body Update Objects UpdateBody true body

UpdateBody

UpdateBody {
url ( string , optional ): Web Address,
web_address_type_id ( integer , optional ): Web Address Type ID,
web_address_type_name ( string , optional ): Web Address Type Name,
is_preferred ( boolean , optional ): Make this the preferred email address
}


Code Message Response
200 Ok
                  
{
  "api_version": "1.0",
  "id": 0,
  "item_id": 0,
  "item_type": "",
  "url": "",
  "web_address_type_id": 0,
  "web_address_type_name": "",
  "is_preferred": true,
  "created_at": "",
  "updated_at": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/api/v1/web_addresses/69

Body:
                  
{
  "web_address_type_id": 2
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 69,
  "item_id": 959480,
  "item_type": "Constituent",
  "url": "www.example.com",
  "web_address_type_id": 2,
  "web_address_type_name": null,
  "is_preferred": false,
  "parent_id": null,
  "created_at": "2024-02-06T15:58:37Z",
  "updated_at": "2024-02-06T15:58:38Z"
}
                



DELETE /api/v1/web_addresses/{id} - Delete Web Address

Delete the web address.

Parameter Name Description Type Required? Parameter Type
id Web Address Id integer true path


Code Message Response
200 Ok
401 Unauthorized
403 Forbidden

Example:

URI: https://api.littlegreenlight.com/api/v1/web_addresses/69

Response:
                  
{
  "api_version": "1.0",
  "result": "success"
}