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"

Category Management

GET /v1/categories - Fetch Categories for Account

Lists all the categories 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,
      "item_type": "Constituent",
      "name": "",
      "key": "",
      "facet_type": "",
      "ordinal": 0,
      "removable": true,
      "editable": true,
      "display_format": "",
      "keywords": [
        {
          "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/v1/categories

Response:
                  
{
  "api_version": "1.0",
  "items_count": 7,
  "total_items": 7,
  "limit": 25,
  "offset": 0,
  "item_type": "category",
  "items": [
    {
      "id": 882,
      "item_type": "Constituent",
      "name": "Constant Contact Status",
      "key": "constant_contact_status",
      "facet_type": "single",
      "ordinal": 0,
      "removable": false,
      "editable": false,
      "display_format": "compact",
      "keywords": [
        {
          "id": 12217,
          "category_id": 882,
          "name": "Active",
          "description": null,
          "short_code": "cc_subscribed",
          "ordinal": 1,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2017-04-09T19:58:53Z",
          "updated_at": "2017-04-09T19:58:53Z"
        },
        {
          "id": 12222,
          "category_id": 882,
          "name": "Inactive",
          "description": null,
          "short_code": "cc_removed",
          "ordinal": 2,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2017-04-09T19:58:53Z",
          "updated_at": "2017-04-09T19:58:53Z"
        },
        {
          "id": 12227,
          "category_id": 882,
          "name": "Invalid Email",
          "description": null,
          "short_code": "cc_invalid",
          "ordinal": 4,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2017-04-09T19:58:53Z",
          "updated_at": "2017-04-09T19:58:53Z"
        },
        {
          "id": 12232,
          "category_id": 882,
          "name": "Unsubscribed",
          "description": null,
          "short_code": "cc_unsubscribed",
          "ordinal": 5,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2017-04-09T19:58:53Z",
          "updated_at": "2017-04-09T19:58:53Z"
        },
        {
          "id": 12237,
          "category_id": 882,
          "name": "Error",
          "description": null,
          "short_code": "cc_error",
          "ordinal": 6,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2017-04-09T19:58:53Z",
          "updated_at": "2017-04-09T19:58:53Z"
        }
      ]
    },
    {
      "id": 877,
      "item_type": "Constituent",
      "name": "Constant Contact Lists",
      "key": "constant_contact_lists",
      "facet_type": "list",
      "ordinal": 1,
      "removable": false,
      "editable": false,
      "display_format": "compact",
      "keywords": [

      ]
    },
    {
      "id": 874,
      "item_type": "Constituent",
      "name": "Acknowledgment Preference",
      "key": "ack_preferences",
      "facet_type": "single",
      "ordinal": 100,
      "removable": false,
      "editable": true,
      "display_format": "compact",
      "keywords": [
        {
          "id": 12214,
          "category_id": 874,
          "name": "Prefers mail",
          "description": null,
          "short_code": "ack_pref_mailing",
          "ordinal": 0,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2016-09-09T01:28:37Z",
          "updated_at": "2016-09-09T01:28:37Z"
        },
        {
          "id": 12215,
          "category_id": 874,
          "name": "Prefers email",
          "description": null,
          "short_code": "ack_pref_email",
          "ordinal": 1,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2016-09-09T01:28:37Z",
          "updated_at": "2016-09-09T01:28:37Z"
        },
        {
          "id": 12216,
          "category_id": 874,
          "name": "Prefers none",
          "description": null,
          "short_code": "ack_pref_none",
          "ordinal": 2,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2016-09-09T01:28:37Z",
          "updated_at": "2016-09-09T01:28:37Z"
        }
      ]
    },
    {
      "id": 866,
      "item_type": "Constituent",
      "name": "Communication Tags",
      "key": "tags",
      "facet_type": "list",
      "ordinal": 100,
      "removable": true,
      "editable": true,
      "display_format": "compact",
      "keywords": [
        {
          "id": 12201,
          "category_id": 866,
          "name": "Annual Appeal",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2014-07-24T17:39:54Z",
          "updated_at": "2014-07-24T17:39:54Z"
        },
        {
          "id": 12184,
          "category_id": 866,
          "name": "Do not call",
          "description": null,
          "short_code": "do_not_call",
          "ordinal": 100,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2013-10-06T03:00:58Z",
          "updated_at": "2013-10-06T03:00:58Z"
        },
        {
          "id": 12183,
          "category_id": 866,
          "name": "Do not email",
          "description": null,
          "short_code": "do_not_email",
          "ordinal": 100,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2013-10-06T03:00:58Z",
          "updated_at": "2013-10-06T03:00:58Z"
        },
        {
          "id": 12182,
          "category_id": 866,
          "name": "Do not mail",
          "description": null,
          "short_code": "do_not_mail",
          "ordinal": 100,
          "removable": false,
          "can_change": true,
          "can_select": true,
          "created_at": "2013-10-06T03:00:58Z",
          "updated_at": "2013-10-06T03:00:58Z"
        },
        {
          "id": 12200,
          "category_id": 866,
          "name": "Famous",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2014-07-23T16:47:52Z",
          "updated_at": "2014-07-23T16:47:52Z"
        },
        {
          "id": 12251,
          "category_id": 866,
          "name": "New Tag",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2017-10-05T21:13:37Z",
          "updated_at": "2017-10-05T21:13:37Z"
        }
      ]
    },
    {
      "id": 867,
      "item_type": "Constituent",
      "name": "Giving Status",
      "key": "giving_status",
      "facet_type": "list",
      "ordinal": 100,
      "removable": false,
      "editable": false,
      "display_format": "compact",
      "keywords": [

      ]
    },
    {
      "id": 1016,
      "item_type": "Constituent",
      "name": "Test Category",
      "key": "759bbf2d_63cd_401b_bc37_8032ad22e8f1",
      "facet_type": "list",
      "ordinal": 100,
      "removable": true,
      "editable": true,
      "display_format": "compact",
      "keywords": [
        {
          "id": 12525,
          "category_id": 1016,
          "name": "test1",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2018-12-08T20:32:27Z",
          "updated_at": "2018-12-08T20:32:27Z"
        },
        {
          "id": 12526,
          "category_id": 1016,
          "name": "test2",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2018-12-08T20:32:27Z",
          "updated_at": "2018-12-08T20:32:27Z"
        },
        {
          "id": 12527,
          "category_id": 1016,
          "name": "test3",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2018-12-08T20:32:27Z",
          "updated_at": "2018-12-08T20:32:27Z"
        }
      ]
    },
    {
      "id": 871,
      "item_type": "Constituent",
      "name": "Volunteer Interests",
      "key": "46f9359e_54bf_4ac5_8272_34615b25b106",
      "facet_type": "list",
      "ordinal": 100,
      "removable": true,
      "editable": true,
      "display_format": "compact",
      "keywords": [
        {
          "id": 12207,
          "category_id": 871,
          "name": "Etc",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2015-03-25T19:16:39Z",
          "updated_at": "2015-03-25T19:16:39Z"
        },
        {
          "id": 12205,
          "category_id": 871,
          "name": "Events",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2015-03-25T19:16:39Z",
          "updated_at": "2015-03-25T19:16:39Z"
        },
        {
          "id": 12206,
          "category_id": 871,
          "name": "Office Work",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2015-03-25T19:16:39Z",
          "updated_at": "2015-03-25T19:16:39Z"
        }
      ]
    }
  ]
}
                



POST /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": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

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

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


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



GET /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": ""
}
                
401 Unauthorized
403 Forbidden

Example:

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

Response:
                  
{
  "api_version": "1.0",
  "id": 866,
  "item_type": "Constituent",
  "name": "Communication Tags",
  "key": "tags",
  "facet_type": "list",
  "ordinal": 100,
  "removable": true,
  "editable": true,
  "display_format": "compact"
}
                



PATCH /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": ""
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

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

Body:
                  
{
  "facet_type": "single"
}
                


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



DELETE /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/v1/categories/1041

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



GET /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": [
        {
          "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/v1/constituents/952156/categories

Response:
                  
{
  "api_version": "1.0",
  "items_count": 1,
  "total_items": 1,
  "limit": 25,
  "offset": 0,
  "item_type": "category",
  "items": [
    {
      "id": 866,
      "item_type": "Constituent",
      "name": "Communication Tags",
      "key": "tags",
      "facet_type": "list",
      "ordinal": 100,
      "removable": true,
      "editable": true,
      "display_format": "compact",
      "keywords": [
        {
          "id": 12200,
          "category_id": 866,
          "name": "Famous",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2014-07-23T16:47:52Z",
          "updated_at": "2014-07-23T16:47:52Z"
        },
        {
          "id": 12201,
          "category_id": 866,
          "name": "Annual Appeal",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2014-07-24T17:39:54Z",
          "updated_at": "2014-07-24T17:39:54Z"
        }
      ]
    }
  ]
}
                



Constituent Management

GET /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
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)
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 = Active, 1 = Lapsed
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)

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:

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

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


Response:
                  
{
  "api_version": "1.0",
  "items_count": 3,
  "total_items": 3,
  "limit": 5,
  "offset": 0,
  "item_type": "constituent",
  "items": [
    {
      "id": 952165,
      "external_constituent_id": null,
      "is_org": false,
      "constituent_contact_type_id": 1178,
      "constituent_contact_type_name": "Spouse/Partner",
      "prefix": null,
      "first_name": "Carol",
      "middle_name": null,
      "last_name": "Brady",
      "suffix": null,
      "spouse_name": "Mike Brady",
      "org_name": null,
      "job_title": null,
      "addressee": "Carol Brady",
      "salutation": "Carol",
      "sort_name": "Brady, Carol",
      "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": "Carol Brady",
      "birthday": null,
      "gender": null,
      "maiden_name": null,
      "nick_name": null,
      "spouse_nick_name": null,
      "date_added": "2014-07-23",
      "alt_salutation": "Carol",
      "alt_addressee": "Carol Brady",
      "honorary_name": "Carol Brady",
      "assistant_name": null,
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2014-07-23T16:48:04Z",
      "updated_at": "2018-11-28T18:53:15Z"
    },
    {
      "id": 952166,
      "external_constituent_id": null,
      "is_org": false,
      "constituent_contact_type_id": 1179,
      "constituent_contact_type_name": "Dependents",
      "prefix": null,
      "first_name": "Greg",
      "middle_name": null,
      "last_name": "Brady",
      "suffix": null,
      "spouse_name": null,
      "org_name": null,
      "job_title": null,
      "addressee": "Greg Brady",
      "salutation": "Greg",
      "sort_name": "Brady, Greg",
      "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": "Greg Brady",
      "birthday": null,
      "gender": null,
      "maiden_name": null,
      "nick_name": null,
      "spouse_nick_name": null,
      "date_added": "2014-07-23",
      "alt_salutation": "Greg",
      "alt_addressee": "Greg Brady",
      "honorary_name": "Greg Brady",
      "assistant_name": null,
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2014-07-23T16:48:05Z",
      "updated_at": "2018-11-28T18:53:15Z"
    },
    {
      "id": 952164,
      "external_constituent_id": "t00072",
      "is_org": false,
      "constituent_contact_type_id": 1177,
      "constituent_contact_type_name": "Primary",
      "prefix": null,
      "first_name": "Mike",
      "middle_name": null,
      "last_name": "Brady",
      "suffix": null,
      "spouse_name": "Carol Brady",
      "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": "2014-07-23",
      "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": "2014-07-23T16:48:04Z",
      "updated_at": "2018-11-28T18:53:15Z"
    }
  ]
}
                

Example:

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

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


Response:
                  
{
  "api_version": "1.0",
  "items_count": 5,
  "total_items": 10,
  "limit": 5,
  "offset": 0,
  "next_item": 5,
  "next_link": "http://api.littlegreenlight.net/api/v1/constituents/search?limit=5&offset=5&q%5B%5D=keyword%3D12185%3Bupdated_from%3D2016-01-01",
  "item_type": "constituent",
  "items": [
    {
      "id": 952257,
      "external_constituent_id": "",
      "is_org": false,
      "constituent_contact_type_id": 1177,
      "constituent_contact_type_name": "Primary",
      "prefix": null,
      "first_name": "HunterTest",
      "middle_name": "",
      "last_name": "Aug2017",
      "suffix": null,
      "spouse_name": "Sarah Parker",
      "org_name": "",
      "job_title": null,
      "addressee": "HunterTest Aug2017",
      "salutation": "HunterTest",
      "sort_name": "Aug2017, HunterTest",
      "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": "HunterTest Aug2017",
      "birthday": null,
      "gender": null,
      "maiden_name": "Barr",
      "nick_name": "",
      "spouse_nick_name": "",
      "date_added": "2017-08-30",
      "alt_salutation": "HunterTest",
      "alt_addressee": "HunterTest Aug2017",
      "honorary_name": "HunterTest Aug2017",
      "assistant_name": null,
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2017-08-30T16:37:03Z",
      "updated_at": "2018-11-28T19:20:13Z"
    },
    {
      "id": 952263,
      "external_constituent_id": null,
      "is_org": false,
      "constituent_contact_type_id": 1177,
      "constituent_contact_type_name": "Primary",
      "prefix": null,
      "first_name": "Eddie",
      "middle_name": "",
      "last_name": "Barone",
      "suffix": null,
      "spouse_name": "",
      "org_name": "",
      "job_title": null,
      "addressee": "Eddie Barone",
      "salutation": "Eddie",
      "sort_name": "Barone, Eddie",
      "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": "Eddie Barone",
      "birthday": null,
      "gender": null,
      "maiden_name": null,
      "nick_name": null,
      "spouse_nick_name": null,
      "date_added": "2017-09-21",
      "alt_salutation": "Eddie",
      "alt_addressee": "Eddie Barone",
      "honorary_name": "Eddie Barone",
      "assistant_name": null,
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2017-09-21T23:08:53Z",
      "updated_at": "2018-11-28T18:53:13Z"
    },
    {
      "id": 952249,
      "external_constituent_id": null,
      "is_org": false,
      "constituent_contact_type_id": 1177,
      "constituent_contact_type_name": "Primary",
      "prefix": null,
      "first_name": "JJJ",
      "middle_name": null,
      "last_name": "BBBB",
      "suffix": null,
      "spouse_name": null,
      "org_name": null,
      "job_title": null,
      "addressee": "JJJ BBBB",
      "salutation": "JJJ",
      "sort_name": "BBBB, JJJ",
      "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": "JJJ BBBB",
      "birthday": null,
      "gender": null,
      "maiden_name": null,
      "nick_name": null,
      "spouse_nick_name": null,
      "date_added": "2015-07-17",
      "alt_salutation": "JJJ",
      "alt_addressee": "JJJ BBBB",
      "honorary_name": "JJJ BBBB",
      "assistant_name": null,
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2015-07-17T06:22:47Z",
      "updated_at": "2018-11-28T18:53:13Z"
    },
    {
      "id": 952251,
      "external_constituent_id": null,
      "is_org": false,
      "constituent_contact_type_id": 1177,
      "constituent_contact_type_name": "Primary",
      "prefix": null,
      "first_name": "Nick",
      "middle_name": null,
      "last_name": "Bicknell",
      "suffix": null,
      "spouse_name": null,
      "org_name": null,
      "job_title": null,
      "addressee": "Nick Bicknell",
      "salutation": "Nick",
      "sort_name": "Bicknell, Nick",
      "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": "Nick Bicknell",
      "birthday": null,
      "gender": null,
      "maiden_name": null,
      "nick_name": null,
      "spouse_nick_name": null,
      "date_added": "2015-08-14",
      "alt_salutation": "Nick",
      "alt_addressee": "Nick Bicknell",
      "honorary_name": "Nick Bicknell",
      "assistant_name": null,
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2015-08-14T08:29:24Z",
      "updated_at": "2018-11-28T18:53:12Z"
    },
    {
      "id": 952252,
      "external_constituent_id": null,
      "is_org": false,
      "constituent_contact_type_id": 1177,
      "constituent_contact_type_name": "Primary",
      "prefix": null,
      "first_name": "Nick",
      "middle_name": null,
      "last_name": "Bicknell",
      "suffix": null,
      "spouse_name": null,
      "org_name": null,
      "job_title": null,
      "addressee": "Nick Bicknell",
      "salutation": "Nick",
      "sort_name": "Bicknell, Nick",
      "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": "Nick Bicknell",
      "birthday": null,
      "gender": null,
      "maiden_name": null,
      "nick_name": null,
      "spouse_nick_name": null,
      "date_added": "2015-08-14",
      "alt_salutation": "Nick",
      "alt_addressee": "Nick Bicknell",
      "honorary_name": "Nick Bicknell",
      "assistant_name": null,
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2015-08-14T08:37:44Z",
      "updated_at": "2018-11-28T18:53:14Z"
    }
  ]
}
                

Example:

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

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


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



GET /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/v1/constituents

Query:
limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 5,
  "total_items": 101,
  "limit": 5,
  "offset": 0,
  "next_item": 5,
  "next_link": "http://api.littlegreenlight.net/api/v1/constituents?limit=5&offset=5",
  "item_type": "constituent",
  "items": [
    {
      "id": 952262,
      "external_constituent_id": "",
      "is_org": false,
      "constituent_contact_type_id": 1177,
      "constituent_contact_type_name": "Primary",
      "prefix": null,
      "first_name": "Bruce",
      "middle_name": "",
      "last_name": "Adler",
      "suffix": null,
      "spouse_name": "",
      "org_name": "",
      "job_title": null,
      "addressee": "Bruce Adler",
      "salutation": "Bruce",
      "sort_name": "Adler, Bruce",
      "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": "Bruce Adler",
      "birthday": null,
      "gender": null,
      "maiden_name": "",
      "nick_name": "",
      "spouse_nick_name": "",
      "date_added": "2017-09-21",
      "alt_salutation": "Bruce",
      "alt_addressee": "Bruce Adler",
      "honorary_name": "Bruce Adler",
      "assistant_name": null,
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2017-09-21T22:53:08Z",
      "updated_at": "2018-12-18T20:05:25Z"
    },
    {
      "id": 952155,
      "external_constituent_id": "t00012",
      "is_org": false,
      "constituent_contact_type_id": 1177,
      "constituent_contact_type_name": "Primary",
      "prefix": null,
      "first_name": "Susan",
      "middle_name": "",
      "last_name": "Alexander",
      "suffix": null,
      "spouse_name": "",
      "org_name": "Citizen Kane",
      "job_title": null,
      "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": "2014-07-23",
      "alt_salutation": "Susan",
      "alt_addressee": "Mrs. Susan Alexander",
      "honorary_name": "Mrs. Susan Alexander",
      "assistant_name": null,
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": true,
      "created_at": "2014-07-23T16:47:52Z",
      "updated_at": "2018-12-18T20:05:25Z"
    },
    {
      "id": 952156,
      "external_constituent_id": "t00044",
      "is_org": false,
      "constituent_contact_type_id": 1177,
      "constituent_contact_type_name": "Primary",
      "prefix": null,
      "first_name": "Larry",
      "middle_name": null,
      "last_name": "Appleton",
      "suffix": null,
      "spouse_name": null,
      "org_name": "Perfect Strangers",
      "job_title": null,
      "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": null,
      "nick_name": null,
      "spouse_nick_name": null,
      "date_added": "2014-07-23",
      "alt_salutation": "Larry",
      "alt_addressee": "Larry Appleton and his cousin Balki Bartokomous",
      "honorary_name": "Larry Appleton and his cousin Balki Bartokomous",
      "assistant_name": null,
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2014-07-23T16:47:53Z",
      "updated_at": "2019-01-17T22:56:07Z"
    },
    {
      "id": 952157,
      "external_constituent_id": "t00050",
      "is_org": false,
      "constituent_contact_type_id": 1177,
      "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": "2014-07-23",
      "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": "2014-07-23T16:47:55Z",
      "updated_at": "2018-11-28T19:20:13Z"
    },
    {
      "id": 952257,
      "external_constituent_id": "",
      "is_org": false,
      "constituent_contact_type_id": 1177,
      "constituent_contact_type_name": "Primary",
      "prefix": null,
      "first_name": "HunterTest",
      "middle_name": "",
      "last_name": "Aug2017",
      "suffix": null,
      "spouse_name": "Sarah Parker",
      "org_name": "",
      "job_title": null,
      "addressee": "HunterTest Aug2017",
      "salutation": "HunterTest",
      "sort_name": "Aug2017, HunterTest",
      "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": "HunterTest Aug2017",
      "birthday": null,
      "gender": null,
      "maiden_name": "Barr",
      "nick_name": "",
      "spouse_nick_name": "",
      "date_added": "2017-08-30",
      "alt_salutation": "HunterTest",
      "alt_addressee": "HunterTest Aug2017",
      "honorary_name": "HunterTest Aug2017",
      "assistant_name": null,
      "marital_status_id": null,
      "marital_status_name": null,
      "is_anon": false,
      "created_at": "2017-08-30T16:37:03Z",
      "updated_at": "2018-11-28T19:20:13Z"
    }
  ]
}
                



POST /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 ): Email Address Objects ,
phone_numbers ( array , optional ): Phone Number Objects ,
street_addresses ( array , optional ): Street Address Objects ,
web_addresses ( array , optional ): Web Address Objects ,
categories ( array , optional ): Constituent Categories ,
groups ( array , optional ): Group 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 ): Email Address Type ID ,
phone_type_name ( string , optional ): Phone Number Type Name ,
is_preferred ( boolean , optional ): Make this the preferred email address ,
not_current ( boolean , optional ): No longer a current email address
}
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
}
Category {
id ( integer , optional ): Category Id ,
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 ,
keywords ( array , required ): Keyword Values
}
Keyword {
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?
}
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?
}


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": [
        {
          "category_id": 0,
          "name": "",
          "description": "",
          "short_code": "",
          "ordinal": 0,
          "removable": true,
          "can_change": true,
          "can_select": true
        }
      ]
    }
  ],
  "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": ""
    }
  ]
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

URI: https://api.littlegreenlight.com/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"
    }
  ]
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 952462,
  "external_constituent_id": "999",
  "is_org": false,
  "constituent_contact_type_id": 1177,
  "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": "2019-01-17",
  "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": "2019-01-17T23:05:00Z",
  "updated_at": "2019-01-17T23:05:00Z",
  "street_addresses": [

  ],
  "phone_numbers": [

  ],
  "email_addresses": [
    {
      "id": 281773,
      "address": "joed@example.com",
      "email_address_type_id": 1,
      "email_type_name": "Home",
      "is_preferred": true,
      "not_current": false,
      "parent_id": null,
      "created_at": "2019-01-17T23:05:00Z",
      "updated_at": "2019-01-17T23:05:00Z"
    }
  ],
  "web_addresses": [

  ],
  "categories": [
    {
      "id": 866,
      "item_type": "Constituent",
      "name": "Communication Tags",
      "key": "tags",
      "facet_type": "list",
      "ordinal": 100,
      "removable": true,
      "editable": true,
      "display_format": "compact",
      "keywords": [
        {
          "id": 12251,
          "category_id": 866,
          "name": "New Tag",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2017-10-05T21:13:37Z",
          "updated_at": "2017-10-05T21:13:37Z"
        }
      ]
    }
  ],
  "groups": [
    {
      "id": 124,
      "constituent_id": 952462,
      "group_id": 1,
      "group_name": "Board Member",
      "date_start": null,
      "date_end": null,
      "is_current": true,
      "created_at": "2019-01-17T23:05:01Z",
      "updated_at": "2019-01-17T23:05:01Z"
    }
  ],
  "memberships": [

  ]
}
                



GET /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": [
        {
          "category_id": 0,
          "name": "",
          "description": "",
          "short_code": "",
          "ordinal": 0,
          "removable": true,
          "can_change": true,
          "can_select": true
        }
      ]
    }
  ],
  "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": ""
    }
  ]
}
                
401 Unauthorized
403 Forbidden

Example:

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

Response:
                  
{
  "api_version": "1.0",
  "id": 952156,
  "external_constituent_id": "t00044",
  "is_org": false,
  "constituent_contact_type_id": 1177,
  "constituent_contact_type_name": "Primary",
  "prefix": null,
  "first_name": "Larry",
  "middle_name": null,
  "last_name": "Appleton",
  "suffix": null,
  "spouse_name": null,
  "org_name": "Perfect Strangers",
  "job_title": null,
  "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": null,
  "nick_name": null,
  "spouse_nick_name": null,
  "date_added": "2014-07-23",
  "alt_salutation": "Larry",
  "alt_addressee": "Larry Appleton and his cousin Balki Bartokomous",
  "honorary_name": "Larry Appleton and his cousin Balki Bartokomous",
  "assistant_name": null,
  "marital_status_id": null,
  "marital_status_name": null,
  "is_anon": false,
  "created_at": "2014-07-23T16:47:53Z",
  "updated_at": "2019-01-17T22:56:07Z",
  "street_addresses": [
    {
      "id": 3,
      "street": "711 Calhoun Street",
      "city": "Chicago",
      "state": "IL",
      "country": "US",
      "postal_code": "60603",
      "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": "60603",
      "verified": false,
      "verified_on": null,
      "created_at": "2014-07-23T16:47:53Z",
      "updated_at": "2018-11-30T18:25:41Z"
    }
  ],
  "phone_numbers": [
    {
      "id": 2,
      "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": "2014-07-23T16:47:53Z",
      "updated_at": "2017-10-05T21:28:38Z"
    }
  ],
  "email_addresses": [
    {
      "id": 281309,
      "address": "appleton@perfectstrangers.com",
      "email_address_type_id": 1,
      "email_type_name": "Home",
      "is_preferred": true,
      "not_current": false,
      "parent_id": null,
      "created_at": "2014-07-23T16:47:53Z",
      "updated_at": "2017-10-05T21:28:38Z"
    },
    {
      "id": 281533,
      "address": "test@example.com",
      "email_address_type_id": 2,
      "email_type_name": "Work",
      "is_preferred": false,
      "not_current": false,
      "parent_id": null,
      "created_at": "2018-06-08T18:58:34Z",
      "updated_at": "2018-06-08T18:58:35Z"
    }
  ],
  "web_addresses": [
    {
      "id": 2,
      "url": "www.example.com",
      "web_address_type_id": 6,
      "web_address_type_name": "Website",
      "is_preferred": false,
      "parent_id": null,
      "created_at": "2017-10-05T21:28:38Z",
      "updated_at": "2017-10-05T21:28:38Z"
    }
  ],
  "categories": [
    {
      "id": 866,
      "item_type": "Constituent",
      "name": "Communication Tags",
      "key": "tags",
      "facet_type": "list",
      "ordinal": 100,
      "removable": true,
      "editable": true,
      "display_format": "compact",
      "keywords": [
        {
          "id": 12200,
          "category_id": 866,
          "name": "Famous",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2014-07-23T16:47:52Z",
          "updated_at": "2014-07-23T16:47:52Z"
        },
        {
          "id": 12201,
          "category_id": 866,
          "name": "Annual Appeal",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2014-07-24T17:39:54Z",
          "updated_at": "2014-07-24T17:39:54Z"
        }
      ]
    }
  ],
  "groups": [
    {
      "id": 3,
      "constituent_id": 952156,
      "group_id": 1,
      "group_name": "Board Member",
      "date_start": null,
      "date_end": null,
      "is_current": true,
      "created_at": "2018-01-29T22:51:11Z",
      "updated_at": "2018-01-29T22:51:11Z"
    }
  ],
  "memberships": [
    {
      "id": 1,
      "constituent_id": 952156,
      "membership_level_id": 1,
      "membership_level_name": "General",
      "date_start": "2015-01-01",
      "finish_date": null,
      "note": "",
      "created_at": "2018-01-29T22:52:56Z",
      "updated_at": "2019-01-17T22:55:58Z"
    }
  ]
}
                



PATCH /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? ,
email_addresses ( array , required ): Email Address Objects ,
phone_numbers ( array , optional ): Phone Number Objects ,
street_addresses ( array , optional ): Street Address Objects ,
web_addresses ( array , optional ): Web Address Objects ,
categories ( array , optional ): Constituent Categories ,
groups ( array , optional ): Group 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 ): Email Address Type ID ,
phone_type_name ( string , optional ): Phone Number Type Name ,
is_preferred ( boolean , optional ): Make this the preferred email address ,
not_current ( boolean , optional ): No longer a current email address
}
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
}
Category {
id ( integer , optional ): Category Id ,
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 ,
keywords ( array , required ): Keyword Values
}
Keyword {
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?
}
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?
}


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": [
        {
          "category_id": 0,
          "name": "",
          "description": "",
          "short_code": "",
          "ordinal": 0,
          "removable": true,
          "can_change": true,
          "can_select": true
        }
      ]
    }
  ],
  "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": ""
    }
  ]
}
                
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Example:

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

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": 952462,
  "external_constituent_id": "999",
  "is_org": false,
  "constituent_contact_type_id": 1177,
  "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": "2019-01-17",
  "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": "2019-01-17T23:05:00Z",
  "updated_at": "2019-01-17T23:05:02Z",
  "street_addresses": [
    {
      "id": 456,
      "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": "2019-01-17T23:05:02Z",
      "updated_at": "2019-01-17T23:05:02Z"
    }
  ],
  "phone_numbers": [

  ],
  "email_addresses": [
    {
      "id": 281773,
      "address": "joed@example.com",
      "email_address_type_id": 1,
      "email_type_name": "Home",
      "is_preferred": true,
      "not_current": false,
      "parent_id": null,
      "created_at": "2019-01-17T23:05:00Z",
      "updated_at": "2019-01-17T23:05:00Z"
    }
  ],
  "web_addresses": [

  ],
  "categories": [
    {
      "id": 866,
      "item_type": "Constituent",
      "name": "Communication Tags",
      "key": "tags",
      "facet_type": "list",
      "ordinal": 100,
      "removable": true,
      "editable": true,
      "display_format": "compact",
      "keywords": [
        {
          "id": 12251,
          "category_id": 866,
          "name": "New Tag",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true,
          "created_at": "2017-10-05T21:13:37Z",
          "updated_at": "2017-10-05T21:13:37Z"
        }
      ]
    }
  ],
  "groups": [
    {
      "id": 124,
      "constituent_id": 952462,
      "group_id": 1,
      "group_name": "Board Member",
      "date_start": null,
      "date_end": null,
      "is_current": true,
      "created_at": "2019-01-17T23:05:01Z",
      "updated_at": "2019-01-17T23:05:01Z"
    }
  ],
  "memberships": [

  ]
}
                



DELETE /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/v1/constituents/952462

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



Contact Reports Management

GET /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/v1/constituents/952156/contact_reports

Response:
                  
{
  "api_version": "1.0",
  "items_count": 1,
  "total_items": 1,
  "limit": 25,
  "offset": 0,
  "item_type": "contact_report",
  "items": [
    {
      "id": 26269,
      "constituent_id": 952156,
      "name": "Contact report for 'Appleton, Larry'",
      "contact_report_type_id": null,
      "contact_report_type_name": null,
      "original_date": "2018-06-05",
      "text": "Reached out to Larry regarding upcoming pledge drive.",
      "team_member": "Nick Bicknell",
      "team_member_email": "nick@littlegreenlight.com",
      "created_at": "2018-06-05T21:34:56Z",
      "updated_at": "2018-06-05T21:37:49Z"
    }
  ]
}
                



POST /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/v1/constituents/952156/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": 26390,
  "constituent_id": 952156,
  "name": "New Contact Report",
  "contact_report_type_id": 2175,
  "contact_report_type_name": "Call",
  "original_date": "2018-06-05",
  "text": "Follow up contact.",
  "team_member": "Nick Bicknell",
  "team_member_email": "nick@littlegreenlight.com",
  "created_at": "2019-01-17T23:05:04Z",
  "updated_at": "2019-01-17T23:05:04Z"
}
                



GET /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:

URI: https://api.littlegreenlight.com/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": 26263,
      "constituent_id": 952220,
      "name": "Dinner with Jerry",
      "contact_report_type_id": null,
      "contact_report_type_name": null,
      "original_date": "2015-03-25",
      "text": "the details of the dinner in here.",
      "team_member": "Nick Bicknell",
      "team_member_email": "nick@littlegreenlight.com",
      "created_at": "2015-03-25T19:14:27Z",
      "updated_at": "2015-03-25T19:14:27Z"
    }
  ]
}
                

Example:

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

Query:
q[]=const_keyword=12200;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": 26390,
      "constituent_id": 952156,
      "name": "New Contact Report",
      "contact_report_type_id": 2175,
      "contact_report_type_name": "Call",
      "original_date": "2018-06-05",
      "text": "Follow up contact.",
      "team_member": "Nick Bicknell",
      "team_member_email": "nick@littlegreenlight.com",
      "created_at": "2019-01-17T23:05:04Z",
      "updated_at": "2019-01-17T23:05:04Z"
    },
    {
      "id": 26269,
      "constituent_id": 952156,
      "name": "Contact report for 'Appleton, Larry'",
      "contact_report_type_id": null,
      "contact_report_type_name": null,
      "original_date": "2018-06-05",
      "text": "Reached out to Larry regarding upcoming pledge drive.",
      "team_member": "Nick Bicknell",
      "team_member_email": "nick@littlegreenlight.com",
      "created_at": "2018-06-05T21:34:56Z",
      "updated_at": "2018-06-05T21:37:49Z"
    }
  ]
}
                



GET /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/v1/contact_reports

Response:
                  
{
  "api_version": "1.0",
  "items_count": 5,
  "total_items": 5,
  "limit": 25,
  "offset": 0,
  "item_type": "contact_report",
  "items": [
    {
      "id": 26263,
      "constituent_id": 952220,
      "name": "Dinner with Jerry",
      "contact_report_type_id": null,
      "contact_report_type_name": null,
      "original_date": "2015-03-25",
      "text": "the details of the dinner in here.",
      "team_member": "Nick Bicknell",
      "team_member_email": "nick@littlegreenlight.com",
      "created_at": "2015-03-25T19:14:27Z",
      "updated_at": "2015-03-25T19:14:27Z"
    },
    {
      "id": 26264,
      "constituent_id": 952257,
      "name": "My contact report summary",
      "contact_report_type_id": 2179,
      "contact_report_type_name": "Proposal",
      "original_date": "2013-08-30",
      "text": "And the details about the contact report.",
      "team_member": "Hunter Williams",
      "team_member_email": "hunter@littlegreenlight.com",
      "created_at": "2017-08-30T16:41:12Z",
      "updated_at": "2017-08-30T16:41:12Z"
    },
    {
      "id": 26265,
      "constituent_id": 952258,
      "name": "Contact report for 'Daley, Tom'",
      "contact_report_type_id": 2175,
      "contact_report_type_name": "Call",
      "original_date": "2017-11-14",
      "text": "Called",
      "team_member": "Chris Bicknell",
      "team_member_email": "chris@littlegreenlight.com",
      "created_at": "2017-11-15T00:40:22Z",
      "updated_at": "2017-11-15T00:40:22Z"
    },
    {
      "id": 26269,
      "constituent_id": 952156,
      "name": "Contact report for 'Appleton, Larry'",
      "contact_report_type_id": null,
      "contact_report_type_name": null,
      "original_date": "2018-06-05",
      "text": "Reached out to Larry regarding upcoming pledge drive.",
      "team_member": "Nick Bicknell",
      "team_member_email": "nick@littlegreenlight.com",
      "created_at": "2018-06-05T21:34:56Z",
      "updated_at": "2018-06-05T21:37:49Z"
    },
    {
      "id": 26390,
      "constituent_id": 952156,
      "name": "New Contact Report",
      "contact_report_type_id": 2175,
      "contact_report_type_name": "Call",
      "original_date": "2018-06-05",
      "text": "Follow up contact.",
      "team_member": "Nick Bicknell",
      "team_member_email": "nick@littlegreenlight.com",
      "created_at": "2019-01-17T23:05:04Z",
      "updated_at": "2019-01-17T23:05:04Z"
    }
  ]
}
                



GET /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/v1/contact_reports/26390

Response:
                  
{
  "api_version": "1.0",
  "id": 26390,
  "constituent_id": 952156,
  "name": "New Contact Report",
  "contact_report_type_id": 2175,
  "contact_report_type_name": "Call",
  "original_date": "2018-06-05",
  "text": "Follow up contact.",
  "team_member": "Nick Bicknell",
  "team_member_email": "nick@littlegreenlight.com",
  "created_at": "2019-01-17T23:05:04Z",
  "updated_at": "2019-01-17T23:05:04Z"
}
                



PATCH /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 {
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/v1/contact_reports/26390

Body:
                  
{
  "contact_report_type_name": "Email"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 26390,
  "constituent_id": 952156,
  "name": "New Contact Report",
  "contact_report_type_id": 2176,
  "contact_report_type_name": "Email",
  "original_date": "2018-06-05",
  "text": "Follow up contact.",
  "team_member": "Nick Bicknell",
  "team_member_email": "nick@littlegreenlight.com",
  "created_at": "2019-01-17T23:05:04Z",
  "updated_at": "2019-01-17T23:05:05Z"
}
                



DELETE /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/v1/contact_reports/26390

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



Email Address Management

GET /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/v1/constituents/952156/email_addresses

Response:
                  
{
  "api_version": "1.0",
  "items_count": 2,
  "total_items": 2,
  "limit": 25,
  "offset": 0,
  "item_type": "email_address",
  "items": [
    {
      "id": 281309,
      "item_id": 952156,
      "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": "2014-07-23T16:47:53Z",
      "updated_at": "2017-10-05T21:28:38Z"
    },
    {
      "id": 281533,
      "item_id": 952156,
      "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": "2018-06-08T18:58:34Z",
      "updated_at": "2018-06-08T18:58:35Z"
    }
  ]
}
                



POST /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/v1/constituents/952156/email_addresses

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


Response:
                  
{
  "api_version": "1.0",
  "id": 281774,
  "item_id": 952156,
  "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": "2019-01-17T23:05:07Z",
  "updated_at": "2019-01-17T23:05:07Z"
}
                



GET /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/v1/email_addresses/281309

Response:
                  
{
  "api_version": "1.0",
  "id": 281309,
  "item_id": 952156,
  "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": "2014-07-23T16:47:53Z",
  "updated_at": "2017-10-05T21:28:38Z"
}
                



PATCH /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/v1/email_addresses/281774

Body:
                  
{
  "email_address_type_id": 2
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 281774,
  "item_id": 952156,
  "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": "2019-01-17T23:05:07Z",
  "updated_at": "2019-01-17T23:05:07Z"
}
                



DELETE /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/v1/email_addresses/281774

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



Group Memberships Management

GET /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/v1/group_memberships/124

Response:
                  
{
  "api_version": "1.0",
  "id": 124,
  "constituent_id": 952462,
  "group_id": 1,
  "group_name": "Board Member",
  "date_start": null,
  "date_end": null,
  "is_current": true,
  "created_at": "2019-01-17T23:05:01Z",
  "updated_at": "2019-01-17T23:05:01Z"
}
                



PATCH /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 {
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/v1/group_memberships/124

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


Response:
                  
{
  "api_version": "1.0",
  "id": 124,
  "constituent_id": 952462,
  "group_id": 1,
  "group_name": "Board Member",
  "date_start": "2016-01-01",
  "date_end": null,
  "is_current": true,
  "created_at": "2019-01-17T23:05:01Z",
  "updated_at": "2019-01-17T23:05:08Z"
}
                



DELETE /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/v1/group_memberships/124

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



GET /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/v1/constituents/952156/group_memberships

Response:
                  
{
  "api_version": "1.0",
  "items_count": 1,
  "total_items": 1,
  "limit": 25,
  "offset": 0,
  "item_type": "group_membership",
  "items": [
    {
      "id": 3,
      "constituent_id": 952156,
      "group_id": 1,
      "group_name": "Board Member",
      "date_start": null,
      "date_end": null,
      "is_current": true,
      "created_at": "2018-01-29T22:51:11Z",
      "updated_at": "2018-01-29T22:51:11Z"
    }
  ]
}
                



POST /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 /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/v1/groups

Response:
                  
{
  "api_version": "1.0",
  "items_count": 3,
  "total_items": 3,
  "limit": 25,
  "offset": 0,
  "item_type": "group",
  "items": [
    {
      "id": 1,
      "name": "Board Member",
      "key": "board_member",
      "ordinal": 0
    },
    {
      "id": 2,
      "name": "Staff",
      "key": "staff",
      "ordinal": 0
    },
    {
      "id": 66,
      "name": "New Group",
      "key": "new_group",
      "ordinal": 10
    }
  ]
}
                



POST /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/v1/groups

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


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



GET /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/v1/groups/177

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



PATCH /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/v1/groups/177

Body:
                  
{
  "ordinal": "10"
}
                


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



DELETE /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/v1/groups/177

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



Keyword Management

GET /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/v1/categories/866/keywords

Response:
                  
{
  "api_version": "1.0",
  "items_count": 6,
  "total_items": 6,
  "limit": 25,
  "offset": 0,
  "item_type": "keyword",
  "items": [
    {
      "id": 12182,
      "category_id": 866,
      "name": "Do not mail",
      "description": null,
      "short_code": "do_not_mail",
      "ordinal": 100,
      "removable": false,
      "can_change": true,
      "can_select": true,
      "created_at": "2013-10-06T03:00:58Z",
      "updated_at": "2013-10-06T03:00:58Z"
    },
    {
      "id": 12183,
      "category_id": 866,
      "name": "Do not email",
      "description": null,
      "short_code": "do_not_email",
      "ordinal": 100,
      "removable": false,
      "can_change": true,
      "can_select": true,
      "created_at": "2013-10-06T03:00:58Z",
      "updated_at": "2013-10-06T03:00:58Z"
    },
    {
      "id": 12184,
      "category_id": 866,
      "name": "Do not call",
      "description": null,
      "short_code": "do_not_call",
      "ordinal": 100,
      "removable": false,
      "can_change": true,
      "can_select": true,
      "created_at": "2013-10-06T03:00:58Z",
      "updated_at": "2013-10-06T03:00:58Z"
    },
    {
      "id": 12200,
      "category_id": 866,
      "name": "Famous",
      "description": null,
      "short_code": null,
      "ordinal": 100,
      "removable": true,
      "can_change": true,
      "can_select": true,
      "created_at": "2014-07-23T16:47:52Z",
      "updated_at": "2014-07-23T16:47:52Z"
    },
    {
      "id": 12201,
      "category_id": 866,
      "name": "Annual Appeal",
      "description": null,
      "short_code": null,
      "ordinal": 100,
      "removable": true,
      "can_change": true,
      "can_select": true,
      "created_at": "2014-07-24T17:39:54Z",
      "updated_at": "2014-07-24T17:39:54Z"
    },
    {
      "id": 12251,
      "category_id": 866,
      "name": "New Tag",
      "description": null,
      "short_code": null,
      "ordinal": 100,
      "removable": true,
      "can_change": true,
      "can_select": true,
      "created_at": "2017-10-05T21:13:37Z",
      "updated_at": "2017-10-05T21:13:37Z"
    }
  ]
}
                



POST /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/v1/categories/866/keywords

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


Response:
                  
{
  "api_version": "1.0",
  "id": 12569,
  "category_id": 866,
  "name": "New Keyword",
  "description": null,
  "short_code": null,
  "ordinal": 100,
  "removable": true,
  "can_change": true,
  "can_select": true,
  "created_at": "2019-01-17T23:05:11Z",
  "updated_at": "2019-01-17T23:05:11Z"
}
                

Example:

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

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


Response:
                  
{
  "api_version": "1.0",
  "id": 12570,
  "category_id": 866,
  "name": "New Keyword 2",
  "description": null,
  "short_code": null,
  "ordinal": 100,
  "removable": true,
  "can_change": true,
  "can_select": true,
  "created_at": "2019-01-17T23:05:12Z",
  "updated_at": "2019-01-17T23:05:12Z"
}
                



POST /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/v1/constituents/952156/keywords

Body:
                  
{
  "id": "12570"
}
                


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



DELETE /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/v1/constituents/952156/keywords/12570

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



GET /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/v1/keywords/12251

Response:
                  
{
  "api_version": "1.0",
  "id": 12251,
  "category_id": 866,
  "name": "New Tag",
  "description": null,
  "short_code": null,
  "ordinal": 100,
  "removable": true,
  "can_change": true,
  "can_select": true,
  "created_at": "2017-10-05T21:13:37Z",
  "updated_at": "2017-10-05T21:13:37Z"
}
                



PATCH /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/v1/keywords/12569

Body:
                  
{
  "short_code": "new_keyword"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 12569,
  "category_id": 866,
  "name": "New Keyword",
  "description": null,
  "short_code": "new_keyword",
  "ordinal": 100,
  "removable": true,
  "can_change": true,
  "can_select": true,
  "created_at": "2019-01-17T23:05:11Z",
  "updated_at": "2019-01-17T23:05:13Z"
}
                



DELETE /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/v1/keywords/12569

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

Example:

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

Query:
permanent=1


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

Example:

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

Query:
permanent=1


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



Membership Levels Management

GET /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/v1/membership_levels

Response:
                  
{
  "api_version": "1.0",
  "items_count": 4,
  "total_items": 4,
  "limit": 25,
  "offset": 0,
  "item_type": "membership_level",
  "items": [
    {
      "id": 1,
      "name": "General",
      "ordinal": 0
    },
    {
      "id": 2,
      "name": "Friend",
      "ordinal": 1
    },
    {
      "id": 6,
      "name": "Gold",
      "ordinal": 100
    },
    {
      "id": 8,
      "name": "Silver",
      "ordinal": 100
    }
  ]
}
                



POST /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/v1/membership_levels

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


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



GET /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/v1/membership_levels/165

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



PATCH /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/v1/membership_levels/165

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


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



DELETE /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/v1/membership_levels/165

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



Membership Management

GET /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/v1/constituents/952156/memberships

Response:
                  
{
  "api_version": "1.0",
  "items_count": 1,
  "total_items": 1,
  "limit": 25,
  "offset": 0,
  "item_type": "membership",
  "items": [
    {
      "id": 1,
      "constituent_id": 952156,
      "membership_level_id": 1,
      "membership_level_name": "General",
      "date_start": "2015-01-01",
      "finish_date": null,
      "note": "",
      "created_at": "2018-01-29T22:52:56Z",
      "updated_at": "2019-01-17T22:55:58Z"
    }
  ]
}
                



POST /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/v1/constituents/952156/memberships

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


Response:
                  
{
  "api_version": "1.0",
  "id": 160,
  "constituent_id": 952156,
  "membership_level_id": 6,
  "membership_level_name": "Gold",
  "date_start": "2012-01-01",
  "finish_date": "2024-01-01",
  "note": null,
  "created_at": "2019-01-17T23:05:16Z",
  "updated_at": "2019-01-17T23:05:16Z"
}
                



GET /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/v1/memberships/160

Response:
                  
{
  "api_version": "1.0",
  "id": 160,
  "constituent_id": 952156,
  "membership_level_id": 6,
  "membership_level_name": "Gold",
  "date_start": "2012-01-01",
  "finish_date": "2024-01-01",
  "note": null,
  "created_at": "2019-01-17T23:05:16Z",
  "updated_at": "2019-01-17T23:05:16Z"
}
                



PATCH /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/v1/memberships/160

Body:
                  
{
  "membership_level_name": "Silver"
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 160,
  "constituent_id": 952156,
  "membership_level_id": 8,
  "membership_level_name": "Silver",
  "date_start": "2012-01-01",
  "finish_date": "2024-01-01",
  "note": null,
  "created_at": "2019-01-17T23:05:16Z",
  "updated_at": "2019-01-17T23:05:17Z"
}
                



DELETE /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/v1/memberships/160

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



Phone Number Management

GET /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/v1/constituents/952156/phone_numbers

Response:
                  
{
  "api_version": "1.0",
  "items_count": 1,
  "total_items": 1,
  "limit": 25,
  "offset": 0,
  "item_type": "phone_number",
  "items": [
    {
      "id": 2,
      "item_id": 952156,
      "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": "2014-07-23T16:47:53Z",
      "updated_at": "2017-10-05T21:28:38Z"
    }
  ]
}
                



POST /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 ): Email Address Type ID ,
phone_type_name ( string , optional ): Phone Number 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": "",
  "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/v1/constituents/952156/phone_numbers

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


Response:
                  
{
  "api_version": "1.0",
  "id": 168,
  "item_id": 952156,
  "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": "2019-01-17T23:05:18Z",
  "updated_at": "2019-01-17T23:05:18Z"
}
                



GET /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/v1/phone_numbers/168

Response:
                  
{
  "api_version": "1.0",
  "id": 168,
  "item_id": 952156,
  "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": "2019-01-17T23:05:18Z",
  "updated_at": "2019-01-17T23:05:18Z"
}
                



PATCH /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 ): Email Address Type ID ,
phone_type_name ( string , optional ): Phone Number 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": "",
  "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/v1/phone_numbers/168

Body:
                  
{
  "phone_number_type_id": 2
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 168,
  "item_id": 952156,
  "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": "2019-01-17T23:05:18Z",
  "updated_at": "2019-01-17T23:05:19Z"
}
                



DELETE /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/v1/phone_numbers/168

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



Street Address Management

GET /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/v1/constituents/952156/street_addresses

Response:
                  
{
  "api_version": "1.0",
  "items_count": 1,
  "total_items": 1,
  "limit": 25,
  "offset": 0,
  "item_type": "street_address",
  "items": [
    {
      "id": 3,
      "item_id": 952156,
      "item_type": "Constituent",
      "street": "711 Calhoun Street",
      "city": "Chicago",
      "state": "IL",
      "country": "US",
      "postal_code": "60603",
      "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": "60603",
      "verified": false,
      "verified_on": null,
      "created_at": "2014-07-23T16:47:53Z",
      "updated_at": "2018-11-30T18:25:41Z"
    }
  ]
}
                



POST /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/v1/constituents/952156/street_addresses

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


Response:
                  
{
  "api_version": "1.0",
  "id": 457,
  "item_id": 952156,
  "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": "2019-01-17T23:05:20Z",
  "updated_at": "2019-01-17T23:05:20Z"
}
                



GET /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/v1/street_addresses/457

Response:
                  
{
  "api_version": "1.0",
  "id": 457,
  "item_id": 952156,
  "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": "2019-01-17T23:05:20Z",
  "updated_at": "2019-01-17T23:05:20Z"
}
                



PATCH /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/v1/street_addresses/457

Body:
                  
{
  "street_address_type_id": 2
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 457,
  "item_id": 952156,
  "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": "2019-01-17T23:05:20Z",
  "updated_at": "2019-01-17T23:05:20Z"
}
                



DELETE /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/v1/street_addresses/457

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



Type Management

GET /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/v1/types

Response:
                  
{
  "api_version": "1.0",
  "items_count": 6,
  "total_items": 6,
  "limit": 25,
  "offset": 0,
  "item_type": "type",
  "items": [
    {
      "name": "Contact Report Types",
      "key": "contact_report_types",
      "values": [
        {
          "id": 2175,
          "name": "Call",
          "display_name": "Call",
          "code": "call",
          "ordinal": 0
        },
        {
          "id": 2176,
          "name": "Email",
          "display_name": "Email",
          "code": "email",
          "ordinal": 1
        },
        {
          "id": 2177,
          "name": "Meeting",
          "display_name": "Meeting",
          "code": "meeting",
          "ordinal": 2
        },
        {
          "id": 2178,
          "name": "Mailing",
          "display_name": "Mailing",
          "code": "letter",
          "ordinal": 3
        },
        {
          "id": 2179,
          "name": "Proposal",
          "display_name": "Proposal",
          "code": "proposal",
          "ordinal": 4
        },
        {
          "id": 2180,
          "name": "Other",
          "display_name": "Other",
          "code": "other",
          "ordinal": 5
        },
        {
          "id": 2181,
          "name": "New Type",
          "display_name": "New Type",
          "code": "new_type",
          "ordinal": 100
        }
      ]
    },
    {
      "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": "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": 6,
          "name": "Website",
          "display_name": "Website",
          "code": "website",
          "ordinal": 0
        },
        {
          "id": 7,
          "name": "Facebook",
          "display_name": "Facebook",
          "code": "facebook",
          "ordinal": 1
        },
        {
          "id": 8,
          "name": "Twitter",
          "display_name": "Twitter",
          "code": "twitter",
          "ordinal": 2
        },
        {
          "id": 9,
          "name": "LinkedIn",
          "display_name": "LinkedIn",
          "code": "linkedin",
          "ordinal": 3
        }
      ]
    },
    {
      "name": "Volunteering Categories",
      "key": "volunteering_categories",
      "values": [
        {
          "id": 4,
          "name": "General",
          "display_name": "General",
          "code": "general",
          "ordinal": 0
        },
        {
          "id": 5,
          "name": "Test 1",
          "display_name": "Test 1",
          "code": "test_1",
          "ordinal": 100
        },
        {
          "id": 6,
          "name": "Test 2",
          "display_name": "Test 2",
          "code": "test_2",
          "ordinal": 100
        }
      ]
    }
  ]
}
                



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

Lists all the values for a type.

Parameter Name Description Type Required? Parameter Type
type type 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/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 /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,
      "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/v1/constituents/952156/volunteer_times

Response:
                  
{
  "api_version": "1.0",
  "items_count": 1,
  "total_items": 1,
  "limit": 25,
  "offset": 0,
  "item_type": "volunteer_time",
  "items": [
    {
      "id": 14,
      "constituent_id": 952156,
      "volunteering_category_id": 4,
      "volunteering_category_name": "General",
      "description": "Donor Management",
      "hours": 4.0,
      "date": "2017-01-02",
      "end_date": "2017-07-11",
      "completed_hours": null,
      "custom_fields": [

      ],
      "created_at": "2018-07-10T18:19:23Z",
      "updated_at": "2018-07-10T18:19:23Z"
    }
  ]
}
                



POST /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 ,
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 ): VolunteerTime custom fields
}
CustomField {
id ( integer , optional ): Custom Field Id ,
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? ,
values ( array , required ): Values
}
CustomValue {
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,
  "constituent_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/v1/constituents/952156/volunteer_times

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


Response:
                  
{
  "api_version": "1.0",
  "id": 104,
  "constituent_id": 952156,
  "volunteering_category_id": 4,
  "volunteering_category_name": "General",
  "description": "Donor management",
  "hours": 4.0,
  "date": "2018-01-02",
  "end_date": null,
  "completed_hours": null,
  "custom_fields": [

  ],
  "created_at": "2019-01-17T23:05:22Z",
  "updated_at": "2019-01-17T23:05:22Z"
}
                



GET /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,
      "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:

URI: https://api.littlegreenlight.com/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": 104,
      "constituent_id": 952156,
      "volunteering_category_id": 4,
      "volunteering_category_name": "General",
      "description": "Donor management",
      "hours": 4.0,
      "date": "2018-01-02",
      "end_date": null,
      "completed_hours": null,
      "custom_fields": [

      ],
      "created_at": "2019-01-17T23:05:22Z",
      "updated_at": "2019-01-17T23:05:22Z"
    },
    {
      "id": 14,
      "constituent_id": 952156,
      "volunteering_category_id": 4,
      "volunteering_category_name": "General",
      "description": "Donor Management",
      "hours": 4.0,
      "date": "2017-01-02",
      "end_date": "2017-07-11",
      "completed_hours": null,
      "custom_fields": [

      ],
      "created_at": "2018-07-10T18:19:23Z",
      "updated_at": "2018-07-10T18:19:23Z"
    }
  ]
}
                

Example:

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

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


Response:
                  
{
  "api_version": "1.0",
  "items_count": 5,
  "total_items": 6,
  "limit": 5,
  "offset": 0,
  "next_item": 5,
  "next_link": "http://api.littlegreenlight.net/api/v1/volunteer_times/search?limit=5&offset=5&q%5B%5D=const_keyword%3D12200%3Bupdated_from%3D2016-01-01",
  "item_type": "volunteer_time",
  "items": [
    {
      "id": 12,
      "constituent_id": 952175,
      "volunteering_category_id": 4,
      "volunteering_category_name": "General",
      "description": "MayDay gold digging fair",
      "hours": 4.0,
      "date": "2018-05-01",
      "end_date": null,
      "completed_hours": null,
      "custom_fields": [

      ],
      "created_at": "2018-03-16T01:19:46Z",
      "updated_at": "2019-01-15T22:54:00Z"
    },
    {
      "id": 104,
      "constituent_id": 952156,
      "volunteering_category_id": 4,
      "volunteering_category_name": "General",
      "description": "Donor management",
      "hours": 4.0,
      "date": "2018-01-02",
      "end_date": null,
      "completed_hours": null,
      "custom_fields": [

      ],
      "created_at": "2019-01-17T23:05:22Z",
      "updated_at": "2019-01-17T23:05:22Z"
    },
    {
      "id": 7,
      "constituent_id": 952164,
      "volunteering_category_id": 4,
      "volunteering_category_name": "General",
      "description": "",
      "hours": 8.0,
      "date": "2017-04-05",
      "end_date": null,
      "completed_hours": null,
      "custom_fields": [

      ],
      "created_at": "2018-03-15T21:22:23Z",
      "updated_at": "2018-03-15T21:22:23Z"
    },
    {
      "id": 4,
      "constituent_id": 952164,
      "volunteering_category_id": 6,
      "volunteering_category_name": "Test 2",
      "description": "",
      "hours": 4.0,
      "date": "2017-02-08",
      "end_date": null,
      "completed_hours": null,
      "custom_fields": [

      ],
      "created_at": "2018-02-20T01:47:51Z",
      "updated_at": "2018-02-20T01:47:51Z"
    },
    {
      "id": 14,
      "constituent_id": 952156,
      "volunteering_category_id": 4,
      "volunteering_category_name": "General",
      "description": "Donor Management",
      "hours": 4.0,
      "date": "2017-01-02",
      "end_date": "2017-07-11",
      "completed_hours": null,
      "custom_fields": [

      ],
      "created_at": "2018-07-10T18:19:23Z",
      "updated_at": "2018-07-10T18:19:23Z"
    }
  ]
}
                



GET /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,
      "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/v1/volunteer_times

Query:
limit=5


Response:
                  
{
  "api_version": "1.0",
  "items_count": 5,
  "total_items": 14,
  "limit": 5,
  "offset": 0,
  "next_item": 5,
  "next_link": "http://api.littlegreenlight.net/api/v1/volunteer_times?offset=5",
  "item_type": "volunteer_time",
  "items": [
    {
      "id": 1,
      "constituent_id": 952242,
      "volunteering_category_id": 4,
      "volunteering_category_name": "General",
      "description": null,
      "hours": 1.0,
      "date": "2015-02-11",
      "end_date": null,
      "completed_hours": null,
      "custom_fields": [

      ],
      "created_at": "2015-02-12T07:49:06Z",
      "updated_at": "2019-01-17T22:10:40Z"
    },
    {
      "id": 2,
      "constituent_id": 952165,
      "volunteering_category_id": 5,
      "volunteering_category_name": "Test 1",
      "description": "",
      "hours": 4.0,
      "date": "2017-01-11",
      "end_date": null,
      "completed_hours": null,
      "custom_fields": [

      ],
      "created_at": "2018-02-20T01:34:20Z",
      "updated_at": "2018-02-20T01:34:20Z"
    },
    {
      "id": 3,
      "constituent_id": 952166,
      "volunteering_category_id": 4,
      "volunteering_category_name": "General",
      "description": "",
      "hours": 4.0,
      "date": "2016-02-24",
      "end_date": null,
      "completed_hours": null,
      "custom_fields": [

      ],
      "created_at": "2018-02-20T01:34:53Z",
      "updated_at": "2018-02-20T01:34:53Z"
    },
    {
      "id": 4,
      "constituent_id": 952164,
      "volunteering_category_id": 6,
      "volunteering_category_name": "Test 2",
      "description": "",
      "hours": 4.0,
      "date": "2017-02-08",
      "end_date": null,
      "completed_hours": null,
      "custom_fields": [

      ],
      "created_at": "2018-02-20T01:47:51Z",
      "updated_at": "2018-02-20T01:47:51Z"
    },
    {
      "id": 5,
      "constituent_id": 952175,
      "volunteering_category_id": 4,
      "volunteering_category_name": "General",
      "description": "",
      "hours": 4.0,
      "date": "2016-02-15",
      "end_date": null,
      "completed_hours": null,
      "custom_fields": [

      ],
      "created_at": "2018-02-20T01:58:10Z",
      "updated_at": "2018-02-20T01:58:10Z"
    }
  ]
}
                



GET /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,
  "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/v1/volunteer_times/104

Response:
                  
{
  "api_version": "1.0",
  "id": 104,
  "constituent_id": 952156,
  "volunteering_category_id": 4,
  "volunteering_category_name": "General",
  "description": "Donor management",
  "hours": 4.0,
  "date": "2018-01-02",
  "end_date": null,
  "completed_hours": null,
  "custom_fields": [

  ],
  "created_at": "2019-01-17T23:05:22Z",
  "updated_at": "2019-01-17T23:05:22Z"
}
                



PATCH /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 ,
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 ): VolunteerTime custom fields
}
CustomField {
id ( integer , optional ): Custom Field Id ,
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? ,
values ( array , required ): Values
}
CustomValue {
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,
  "constituent_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/v1/volunteer_times/104

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


Response:
                  
{
  "api_version": "1.0",
  "id": 104,
  "constituent_id": 952156,
  "volunteering_category_id": 4,
  "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": [
    {
      "id": 1029,
      "item_type": "VolunteerTime",
      "name": "Sponsor",
      "key": "c4e21d34_ac79_4c84_86ca_2cabcc5706ab",
      "facet_type": "single",
      "ordinal": 100,
      "removable": true,
      "editable": true,
      "values": [
        {
          "id": 12546,
          "category_id": 1029,
          "name": "LGL",
          "description": null,
          "short_code": null,
          "ordinal": 100,
          "removable": true,
          "can_change": true,
          "can_select": true
        }
      ]
    }
  ],
  "created_at": "2019-01-17T23:05:22Z",
  "updated_at": "2019-01-17T23:05:24Z"
}
                



DELETE /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/v1/volunteer_times/104

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



Web Address Management

GET /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/v1/constituents/952156/web_addresses

Response:
                  
{
  "api_version": "1.0",
  "items_count": 1,
  "total_items": 1,
  "limit": 25,
  "offset": 0,
  "item_type": "web_address",
  "items": [
    {
      "id": 2,
      "item_id": 952156,
      "item_type": "Constituent",
      "url": "www.example.com",
      "web_address_type_id": 6,
      "web_address_type_name": "Website",
      "is_preferred": false,
      "parent_id": null,
      "created_at": "2017-10-05T21:28:38Z",
      "updated_at": "2017-10-05T21:28:38Z"
    }
  ]
}
                



POST /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/v1/constituents/952156/web_addresses

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


Response:
                  
{
  "api_version": "1.0",
  "id": 14,
  "item_id": 952156,
  "item_type": "Constituent",
  "url": "www.example.com",
  "web_address_type_id": 6,
  "web_address_type_name": "Website",
  "is_preferred": false,
  "parent_id": null,
  "created_at": "2019-01-17T23:05:25Z",
  "updated_at": "2019-01-17T23:05:25Z"
}
                



GET /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/v1/web_addresses/14

Response:
                  
{
  "api_version": "1.0",
  "id": 14,
  "item_id": 952156,
  "item_type": "Constituent",
  "url": "www.example.com",
  "web_address_type_id": 6,
  "web_address_type_name": "Website",
  "is_preferred": false,
  "parent_id": null,
  "created_at": "2019-01-17T23:05:25Z",
  "updated_at": "2019-01-17T23:05:25Z"
}
                



PATCH /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/v1/web_addresses/14

Body:
                  
{
  "web_address_type_id": 2
}
                


Response:
                  
{
  "api_version": "1.0",
  "id": 14,
  "item_id": 952156,
  "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": "2019-01-17T23:05:25Z",
  "updated_at": "2019-01-17T23:05:26Z"
}
                



DELETE /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/v1/web_addresses/14

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