Static REST Documentation
Also available: dynamic REST documentation
This documentation explains the syntax of our API and provides examples on how to use it. If you don't have an API key, please see our API page for more information.
By using LGL's APIs, you represent that you have read and fully understand our API Terms of Use Agreement.
Authentication
Generate an API key
Administrators can generate API keys in their Little Green Light account by going to Settings > Integration settings, and then clicking on the LGL API link. If that link is not visible, please request access by writing to support@littlegreenlight.com, with details about how you plan to use the API and which LGL account you will use for development.
Using your API key
There are three ways you can pass your API key to the LGL API server. You will need to check with your HTTP or Client library for how to use each method. Examples use the 'curl' command line application.
HTTP Basic Authentication
HTTP Basic Authentication allows you to pass a username and password. In this case, set the username to the API key and leave the password blank.
Example:
curl -u [api_key]: "https://api.littlegreenlight.com/api/v1/constituents"
Use the "access_token" parameter
You can provide the API key in each call by using the "access_token" parameter.
Example:
curl "https://api.littlegreenlight.com/api/v1/constituents?access_token=[api_key]"
Use the "Bearer" HTTP authorization header
Example:
curl -H "Authorization: Bearer [api_key]" "https://api.littlegreenlight.com/api/v1/constituents"
AppealRequests Management
GET /api/v1/appeals/{appeal_id}/appeal_requests - Fetch Appeal Requests for Appeal
Lists all the appeal requests for an appeal.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| appeal_id | Appeal Id | integer | true | path |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/appeals/2663/appeal_requestsQuery:
limit=5 |
Response:
|
POST /api/v1/appeals/{appeal_id}/appeal_requests - Create new Appeal Request
Add appeal request.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| appeal_id | Appeal Id | integer | true | path |
| body | Create Objects | CreateBody | true | body |
CreateBody
|
CreateBody {
constituent_id
(
integer
, required
):
Constituent Id,
appeal_id
(
integer
, required
):
Appeal Id,
ask_amount
(
double
, optional
):
Donated,
status
(
string
, optional
):
Status,
assigned_to
(
integer
, optional
):
Assigned to team member id,
custom_fields
(
array
, optional
, CustomFieldAggregatedUpdate
):
Appeal request custom fields (Categories),
custom_attrs
(
array
, optional
, CustomAttr_create
):
Appeal request custom attributes
}
CustomFieldAggregatedUpdate {
id
(
integer
, optional
):
Custom Field Id,
name
(
string
, required
):
Name,
key
(
string
, optional
):
Key,
remove_previous_values
(
boolean
, optional
):
Remove previous field values,
values
(
array
, required
, CustomValueAggregatedUpdate
):
Values
}
CustomValueAggregatedUpdate {
id
(
integer
, required
):
Value Id,
name
(
string
, required
):
Name
}
CustomAttr_create {
id
(
integer
, optional
):
Custom Field Id,
key
(
string
, optional
):
Key,
value
(
string
, required
):
Value
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/appeals/2663/appeal_requestsBody:
|
Response:
|
GET /api/v1/appeal_requests/{id} - Show Appeal Request details
Show details for the appeal request.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Appeal Request Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/appeal_requests/316224Response:
|
PATCH /api/v1/appeal_requests/{id} - Update Appeal Request
Update the appeal request.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Appeal Request Id | integer | true | path |
| body | Update Objects | UpdateBody | true | body |
UpdateBody
|
UpdateBody {
constituent_id
(
integer
, required
):
Constituent Id,
appeal_id
(
integer
, required
):
Appeal Id,
ask_amount
(
double
, optional
):
Donated,
status
(
string
, optional
):
Status,
assigned_to
(
integer
, optional
):
Assigned to team member id,
custom_fields
(
array
, optional
, CustomFieldAggregatedUpdate
):
Appeal request custom fields (Categories),
custom_attrs
(
array
, optional
, CustomAttr_create
):
Appeal request custom attributes
}
CustomFieldAggregatedUpdate {
id
(
integer
, optional
):
Custom Field Id,
name
(
string
, required
):
Name,
key
(
string
, optional
):
Key,
remove_previous_values
(
boolean
, optional
):
Remove previous field values,
values
(
array
, required
, CustomValueAggregatedUpdate
):
Values
}
CustomValueAggregatedUpdate {
id
(
integer
, required
):
Value Id,
name
(
string
, required
):
Name
}
CustomAttr_create {
id
(
integer
, optional
):
Custom Field Id,
key
(
string
, optional
):
Key,
value
(
string
, required
):
Value
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/appeal_requests/316224Body:
|
Response:
|
DELETE /api/v1/appeal_requests/{id} - Delete Appeal Request
Delete the appeal request.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Appeal Request Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/appeal_requests/316224Response:
|
POST /api/v1/constituents/{constituent_id}/appeal_requests - Create new Appeal Request for Constituent
Add appeal request to constituent.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| body | Create Objects | CreateBody_Const | true | body |
CreateBody_Const
|
CreateBody_Const {
appeal_id
(
integer
, required
):
Appeal Id,
ask_amount
(
double
, optional
):
Donated,
status
(
string
, optional
):
Status,
assigned_to
(
integer
, optional
):
Assigned to team member id,
custom_fields
(
array
, optional
, CustomFieldAggregatedUpdate
):
Appeal request custom fields (Categories),
custom_attrs
(
array
, optional
, CustomAttr_create
):
Appeal request custom attributes
}
CustomFieldAggregatedUpdate {
id
(
integer
, optional
):
Custom Field Id,
name
(
string
, required
):
Name,
key
(
string
, optional
):
Key,
remove_previous_values
(
boolean
, optional
):
Remove previous field values,
values
(
array
, required
, CustomValueAggregatedUpdate
):
Values
}
CustomValueAggregatedUpdate {
id
(
integer
, required
):
Value Id,
name
(
string
, required
):
Name
}
CustomAttr_create {
id
(
integer
, optional
):
Custom Field Id,
key
(
string
, optional
):
Key,
value
(
string
, required
):
Value
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
GET /api/v1/constituents/{constituent_id}/appeal_requests - Fetch Appeal Requests for Constituent
Lists all the appeal requests for a constituent.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/appeal_requestsQuery:
limit=5 |
Response:
|
Appeals Management
GET /api/v1/appeals - Fetch Appeals
Lists all the appeals.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/appealsQuery:
limit=5 |
Response:
|
Campaigns Management
GET /api/v1/campaigns - Fetch Campaigns
Lists all the campaigns.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/campaignsQuery:
limit=5 |
Response:
|
Category Management
GET /api/v1/categories - Fetch Categories for Account
Lists all the categories for an account.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| item_type | Categories for type (default: Constituent). Available: Constituent, Gift, VolunteerTime | string | query | |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/categoriesQuery:
limit=5 |
Response:
|
Example:
URI: https://api.littlegreenlight.com/api/v1/categoriesQuery:
item_type=Gift |
Response:
|
POST /api/v1/categories - Create new Category
Add a category to an account.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| body | Create Objects | CreateBody | true | body |
CreateBody
|
CreateBody {
item_type
(
string
, required
):
Item Type,
name
(
string
, required
):
Name,
key
(
string
, optional
):
Key,
facet_type
(
string
, optional
):
Facet Type,
ordinal
(
integer
, optional
):
Ordinal,
removable
(
boolean
, optional
):
Removable?,
editable
(
boolean
, optional
):
Editable?,
display_format
(
string
, optional
):
Display Format
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/categoriesBody:
|
Response:
|
GET /api/v1/categories/{id} - Show Category details
Show details for the category.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Category Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/categories/1042Response:
|
PATCH /api/v1/categories/{id} - Update Category
Update the category.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Category Id | integer | true | path |
| body | Update Objects | UpdateBody | true | body |
UpdateBody
|
UpdateBody {
item_type
(
string
, required
):
Item Type,
name
(
string
, required
):
Name,
key
(
string
, optional
):
Key,
facet_type
(
string
, optional
):
Facet Type,
ordinal
(
integer
, optional
):
Ordinal,
removable
(
boolean
, optional
):
Removable?,
editable
(
boolean
, optional
):
Editable?,
display_format
(
string
, optional
):
Display Format
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/categories/1100Body:
|
Response:
|
DELETE /api/v1/categories/{id} - Delete Category
Delete the category.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Category Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/categories/1100Response:
|
GET /api/v1/constituents/{constituent_id}/categories - Fetch Categories for Constituent
Lists all the categories for a constituent.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/categoriesResponse:
|
Class Affiliation Types Management
GET /api/v1/class_affiliation_types - Fetch Class Affiliation Types
Lists all the class affiliation types.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/class_affiliation_typesQuery:
limit=5 |
Response:
|
Class Affiliations Management
GET /api/v1/constituents/{constituent_id}/class_affiliations - Fetch Class Affiliations
Lists all the class affiliations.| 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 |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/class_affiliationsResponse:
|
POST /api/v1/constituents/{constituent_id}/class_affiliations - Create new Class Affiliation
Add class affiliation.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| body | Create Objects | CreateBody | true | body |
CreateBody
|
CreateBody {
id
(
integer
, optional
):
Class Affiliation ID,
class_affiliation_type_id
(
integer
, optional
):
Class Affiliation Type ID,
year
(
integer
, optional
):
Year,
note
(
string
, optional
):
Note
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/class_affiliationsBody:
|
Response:
|
GET /api/v1/class_affiliations/{id} - Show Class Affiliation details
Show details for the class affiliation.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Class Affiliation Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/class_affiliations/159Response:
|
PATCH /api/v1/class_affiliations/{id} - Update Class Affiliation
Update the class affiliation.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Class Affiliation Id | integer | true | path |
| body | Update Objects | UpdateBody | true | body |
UpdateBody
|
UpdateBody {
id
(
integer
, optional
):
Class Affiliation ID,
class_affiliation_type_id
(
integer
, optional
):
Class Affiliation Type ID,
year
(
integer
, optional
):
Year,
note
(
string
, optional
):
Note
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/class_affiliations/166Body:
|
Response:
|
DELETE /api/v1/class_affiliations/{id} - Delete Class Affiliation
Delete the class affiliation.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Class Affiliation Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/class_affiliations/166Response:
|
Constituent Management
GET /api/v1/constituents/search - Search for Constituents
Search for active constituents.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| q[] | Query String. (EX: name=brady) | string | true | query |
| expand | Expand requested, comma separated, data structures: 'class_affiliations, relationships, street_addresses, phone_numbers, email_addresses, web_addresses, categories, groups, memberships, custom_attrs' | string | query | |
| sort | Sort by one of the following fields: 'name, external_id, lgl_id, date_created, date_updated, membership_level, membership_end_date_from'. Add an exclamation point to reverse the order. (EX: sort=name!) | string | query | |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Available Search Terms:
| Name | name | Any name field contains term |
| eaddr | Email contains term | |
| Phone Number | phone_number | Phone number contains term |
| Street Address | street | Street contains term |
| city | City equals term | |
| state | State equals term (2 letter) | |
| postal_code | Postal code equals term (matches left most characters) | |
| country | Country contains term | |
| Keyword | keyword | Has keyword ID |
| Updated At | updated_from | Date updated from (YYYY-MM-DDTHH:MM:SSZ) |
| updated_to | Date updated to (YYYY-MM-DDTHH:MM:SSZ) | |
| Membership | membership_status | 0 = Lapsed, 1 = Active |
| membership_level | Comma separated membership_level_ids | |
| membership_end_date_from | Latest membership end date from (YYYY-MM-DD) | |
| membership_end_date_to | Latest membership end date to (YYYY-MM-DD) | |
| External ID | external_id | The external_id equals term |
| Constituent Type | constituent_type | 0 = Individual, 1 = Organization |
| Groups | groups | Comma separated group_ids |
| Class Affiliations | class | "type[,type]|YYYY-MM-DD[ to YYYY-MM-DD]" (Dates) |
| Custom Attributes | custom_attr | "key|op|value" |
| key: | Custom attribute key | |
| op: | Operator: | |
| "ft" - contains | ||
| "nft" - doesn't contains | ||
| "eq" - equals | ||
| "ne" - doesn't equal | ||
| "sw" - starts with | ||
| "bl" - is blank | ||
| "nb" - not blank | ||
| custom_attr_from | "key|YYYY-MM-DD" (Dates) | |
| custom_attr_to | "key|YYYY-MM-DD" (Dates) | |
| custom_attr_int | "key|op|number[|number2]" (Number, Currency) | |
| key: | Custom attribute key | |
| op: | Operator: | |
| "gte" - is greater/equal | ||
| "lte" - is less/equal | ||
| "btw" - is between number and number2 | ||
| "gt" - is greater than | ||
| "lt" - is less than | ||
| "eq" - equals | ||
| "ne" - doesn't equal |
Note: Multiple terms may be combined using a semi-colon: "membership_end_date_from=2018-05-04;membership_end_date_to=2018-05-04"
Example - Search by Name and sort:
URI: https://api.littlegreenlight.com/api/v1/constituents/searchQuery:
q[]=name=brady&sort=name&limit=5 |
Response:
|
Example - Search by Name and Expand Class Affiliation, Relationship, Address, Phone, and Email Records:
URI: https://api.littlegreenlight.com/api/v1/constituents/searchQuery:
q[]=name=brady&expand=class_affiliations,relationships,street_addresses,phone_numbers,email_addresses&limit=3 |
Response:
|
Example - Search by Custom Keyword ID and Updated Since:
URI: https://api.littlegreenlight.com/api/v1/constituents/searchQuery:
q[]=keyword=12221;updated_from=2016-01-01&limit=5 |
Response:
|
Example - Search For Organizations, Sort by Date Updated:
URI: https://api.littlegreenlight.com/api/v1/constituents/searchQuery:
q[]=constituent_type=1&sort=date_updated!&limit=5 |
Response:
|
Example - Search Full Text of Custom Attribute:
URI: https://api.littlegreenlight.com/api/v1/constituents/searchQuery:
q[]=custom_attr=background_info|ft|Ck returned&limit=5 |
Response:
|
Example - Search Between Numbers for Custom Attribute:
URI: https://api.littlegreenlight.com/api/v1/constituents/searchQuery:
q[]=custom_attr_int=test_number|btw|5|50&limit=5 |
Response:
|
Example - Search for Parent and Grandparent Class Affiliations between 2000 and 2009:
URI: https://api.littlegreenlight.com/api/v1/constituents/searchQuery:
q[]=class=516,517|2000 to 2009&expand=class_affiliations&limit=5 |
Response:
|
Example - Unknown Parameter Error:
URI: https://api.littlegreenlight.com/api/v1/constituents/searchQuery:
q[]=badterm=1&limit=5 |
Response:
|
GET /api/v1/constituents - Fetch all Constituents for an account
This lists all the active constituents for an account.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituentsQuery:
limit=5 |
Response:
|
POST /api/v1/constituents - Create new Constituent
Add a Constituent to an account along with related objects.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| body | Create Objects | CreateBody | true | body |
CreateBody
|
CreateBody {
external_constituent_id
(
integer
, optional
):
External constituent ID,
is_org
(
boolean
, optional
):
This constituent is an organization or company,
constituent_contact_type_id
(
integer
, optional
):
Constituent contact type ID,
constituent_contact_type_name
(
string
, optional
):
Constituent contact type,
prefix
(
string
, optional
):
Prefix,
first_name
(
string
, required
):
First name,
middle_name
(
string
, optional
):
Middle name,
last_name
(
string
, required
):
Last name,
suffix
(
string
, optional
):
Suffix,
spouse_name
(
string
, optional
):
Spouse/Partner,
org_name
(
string
, optional
):
Organization name,
job_title
(
string
, optional
):
Job title,
addressee
(
string
, optional
):
Addressee/Label name,
salutation
(
string
, optional
):
Salutation,
is_deceased
(
boolean
, optional
):
Deceased?,
deceased_date
(
string
, optional
):
Deceased date,
annual_report_name
(
string
, optional
):
Annual report name,
birthday
(
date
, optional
):
Birthday,
gender
(
string
, optional
):
Gender,
maiden_name
(
string
, optional
):
Maiden name,
nick_name
(
string
, optional
):
Nickname,
spouse_nick_name
(
string
, optional
):
Spouse nickname,
date_added
(
date
, optional
):
Date added,
alt_salutation
(
string
, optional
):
Alt salutation,
alt_addressee
(
string
, optional
):
Alt addressee,
honorary_name
(
string
, optional
):
Honorary name,
assistant_name
(
string
, optional
):
Assistant name,
marital_status_id
(
integer
, optional
):
Marital status ID,
marital_status_name
(
string
, optional
):
Marital status,
is_anon
(
boolean
, optional
):
Gives anonymously?,
class_affiliations
(
array
, optional
, ClassAffiliation
):
Class Affiliation Objects,
relationships
(
array
, optional
, ConstituentRelationship
):
Relationship Objects,
email_addresses
(
array
, required
, EmailAddress
):
Email Address Objects,
phone_numbers
(
array
, optional
, PhoneNumber
):
Phone Number Objects,
street_addresses
(
array
, optional
, StreetAddress
):
Street Address Objects,
web_addresses
(
array
, optional
, WebAddress
):
Web Address Objects,
categories
(
array
, optional
, CategoryAggregatedCreate
):
Constituent Categories,
groups
(
array
, optional
, GroupMembership
):
Group Objects,
custom_attrs
(
array
, optional
, CustomAttr_create
):
Custom Attribute Objects
}
ClassAffiliation {
id
(
integer
, optional
):
Class Affiliation ID,
class_affiliation_type_id
(
integer
, optional
):
Class Affiliation Type ID,
year
(
integer
, optional
):
Year,
note
(
string
, optional
):
Note
}
ConstituentRelationship {
id
(
integer
, optional
):
ConstituentRelationship ID,
related_constituent_id
(
integer
, optional
):
Related Constituent ID,
relationship_type_id
(
integer
, optional
):
Relationship Type ID,
name
(
string
, optional
):
Relationship name,
description
(
string
, optional
):
Relationship description,
reciprocal_id
(
integer
, optional
):
Reciprocal Relationship Type ID,
rec_name
(
string
, optional
):
Reciprocal relationship name,
reciprocal_description
(
string
, optional
):
Reciprocal relationship description,
share_address
(
integer
, optional
):
Share address?,
share_phone
(
integer
, optional
):
Share phone?,
auto_soft_credit
(
boolean
, optional
):
Automatically soft credit?,
also_acknowledge
(
boolean
, optional
):
Send memorial acknowledgements?,
created_at
(
datetime
, optional
):
Created At date and time,
updated_at
(
datetime
, optional
):
Updated At date and time
}
EmailAddress {
address
(
string
, optional
):
Email Address,
email_address_type_id
(
integer
, optional
):
Email Address Type ID,
email_type_name
(
string
, optional
):
Email Address Type Name,
is_preferred
(
boolean
, optional
):
Make this the preferred email address,
not_current
(
boolean
, optional
):
No longer a current email address
}
PhoneNumber {
number
(
string
, optional
):
Phone Number,
phone_number_type_id
(
integer
, optional
):
Phone Number Type Id,
phone_type_name
(
string
, optional
):
Phone Number Type Name,
is_preferred
(
boolean
, optional
):
Make this the preferred phone number,
not_current
(
boolean
, optional
):
No longer a current phone number
}
StreetAddress {
street
(
string
, optional
):
Street,
street_address_type_id
(
integer
, optional
):
Street Address Type ID,
street_type_name
(
string
, optional
):
Street Address Type Name,
city
(
string
, optional
):
City,
state
(
string
, optional
):
State/Province,
postal_code
(
string
, optional
):
Zip/Postal Code,
county
(
string
, optional
):
County,
country
(
string
, optional
):
Country,
seasonal_from
(
string
, optional
):
Seasonal from (mm-dd),
seasonal_to
(
string
, optional
):
Seasonal to (mm-dd),
seasonal
(
boolean
, optional
):
Is seasonal?,
is_preferred
(
boolean
, optional
):
Is preferred address,
not_current
(
boolean
, optional
):
Not current?
}
WebAddress {
url
(
string
, optional
):
Web Address,
web_address_type_id
(
integer
, optional
):
Web Address Type ID,
web_address_type_name
(
string
, optional
):
Web Address Type Name,
is_preferred
(
boolean
, optional
):
Make this the preferred email address
}
CategoryAggregatedCreate {
id
(
integer
, optional
):
Category Id,
name
(
string
, required
):
Name,
key
(
string
, optional
):
Key,
keywords
(
array
, required
, KeywordAggregatedUpdate
):
Keyword Values
}
KeywordAggregatedUpdate {
id
(
integer
, required
):
Keyword Id,
name
(
string
, required
):
Name,
short_code
(
string
, optional
):
Short Code
}
GroupMembership {
group_id
(
integer
, required
):
Group Id,
group_name
(
string
, optional
):
Group Name,
date_start
(
date
, optional
):
Start Date,
date_end
(
date
, optional
):
End Date,
is_current
(
boolean
, optional
):
Current?
}
CustomAttr_create {
id
(
integer
, optional
):
Custom Field Id,
key
(
string
, optional
):
Key,
value
(
string
, required
):
Value
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituentsBody:
|
Response:
|
GET /api/v1/constituents/{id} - Show Constituent details
Show details for the constituent.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Constituent Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480Response:
|
PATCH /api/v1/constituents/{id} - Update constituent
Update the Constituent along with related objects| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Constituent Id | integer | true | path |
| body | Update Objects | UpdateBody | true | body |
UpdateBody
|
UpdateBody {
external_constituent_id
(
integer
, optional
):
External constituent ID,
is_org
(
boolean
, optional
):
This constituent is an organization or company,
constituent_contact_type_id
(
integer
, optional
):
Constituent contact type ID,
constituent_contact_type_name
(
string
, optional
):
Constituent contact type,
prefix
(
string
, optional
):
Prefix,
first_name
(
string
, required
):
First name,
middle_name
(
string
, optional
):
Middle name,
last_name
(
string
, required
):
Last name,
suffix
(
string
, optional
):
Suffix,
spouse_name
(
string
, optional
):
Spouse/Partner,
org_name
(
string
, optional
):
Organization name,
job_title
(
string
, optional
):
Job title,
addressee
(
string
, optional
):
Addressee/Label name,
salutation
(
string
, optional
):
Salutation,
is_deceased
(
boolean
, optional
):
Deceased?,
deceased_date
(
string
, optional
):
Deceased date,
annual_report_name
(
string
, optional
):
Annual report name,
birthday
(
date
, optional
):
Birthday,
gender
(
string
, optional
):
Gender,
maiden_name
(
string
, optional
):
Maiden name,
nick_name
(
string
, optional
):
Nickname,
spouse_nick_name
(
string
, optional
):
Spouse nickname,
date_added
(
date
, optional
):
Date added,
alt_salutation
(
string
, optional
):
Alt salutation,
alt_addressee
(
string
, optional
):
Alt addressee,
honorary_name
(
string
, optional
):
Honorary name,
assistant_name
(
string
, optional
):
Assistant name,
marital_status_id
(
integer
, optional
):
Marital status ID,
marital_status_name
(
string
, optional
):
Marital status,
is_anon
(
boolean
, optional
):
Gives anonymously?,
remove_previous_class_affiliations
(
boolean
, optional
):
Remove previous class affiliations,
class_affiliations
(
array
, optional
, ClassAffiliationUpdate
):
Class Affiliation Objects,
remove_previous_relationships
(
boolean
, optional
):
Remove previous relationships,
relationships
(
array
, optional
, ConstituentRelationshipUpdate
):
Relationship Objects,
remove_previous_email_addresses
(
boolean
, optional
):
Remove previous email addresses,
email_addresses
(
array
, required
, EmailAddress
):
Email Address Objects,
remove_previous_phone_numbers
(
boolean
, optional
):
Remove previous phone numbers,
phone_numbers
(
array
, optional
, PhoneNumber
):
Phone Number Objects,
remove_previous_street_addresses
(
boolean
, optional
):
Remove previous street addresses,
street_addresses
(
array
, optional
, StreetAddress
):
Street Address Objects,
remove_previous_web_addresses
(
boolean
, optional
):
Remove previous web addresses,
web_addresses
(
array
, optional
, WebAddress
):
Web Address Objects,
categories
(
array
, optional
, CategoryAggregatedUpdate
):
Constituent Categories,
remove_previous_groups
(
boolean
, optional
):
Remove previous groups,
groups
(
array
, optional
, GroupMembershipUpdate
):
Group Objects,
custom_attrs
(
array
, optional
, CustomAttr_create
):
Custom Attribute Objects
}
ClassAffiliationUpdate {
id
(
integer
, optional
):
Class Affiliation ID,
class_affiliation_type_id
(
integer
, optional
):
Class Affiliation Type ID,
year
(
integer
, optional
):
Year,
note
(
string
, optional
):
Note
}
ConstituentRelationshipUpdate {
id
(
integer
, optional
):
ConstituentRelationship ID,
related_constituent_id
(
integer
, optional
):
Related Constituent ID,
relationship_type_id
(
integer
, optional
):
Relationship Type ID,
name
(
string
, optional
):
Relationship name,
description
(
string
, optional
):
Relationship description,
reciprocal_id
(
integer
, optional
):
Reciprocal Relationship Type ID,
rec_name
(
string
, optional
):
Reciprocal relationship name,
reciprocal_description
(
string
, optional
):
Reciprocal relationship description,
share_address
(
integer
, optional
):
Share address?,
share_phone
(
integer
, optional
):
Share phone?,
auto_soft_credit
(
boolean
, optional
):
Automatically soft credit?,
also_acknowledge
(
boolean
, optional
):
Send memorial acknowledgements?,
created_at
(
datetime
, optional
):
Created At date and time,
updated_at
(
datetime
, optional
):
Updated At date and time
}
EmailAddress {
address
(
string
, optional
):
Email Address,
email_address_type_id
(
integer
, optional
):
Email Address Type ID,
email_type_name
(
string
, optional
):
Email Address Type Name,
is_preferred
(
boolean
, optional
):
Make this the preferred email address,
not_current
(
boolean
, optional
):
No longer a current email address
}
PhoneNumber {
number
(
string
, optional
):
Phone Number,
phone_number_type_id
(
integer
, optional
):
Phone Number Type Id,
phone_type_name
(
string
, optional
):
Phone Number Type Name,
is_preferred
(
boolean
, optional
):
Make this the preferred phone number,
not_current
(
boolean
, optional
):
No longer a current phone number
}
StreetAddress {
street
(
string
, optional
):
Street,
street_address_type_id
(
integer
, optional
):
Street Address Type ID,
street_type_name
(
string
, optional
):
Street Address Type Name,
city
(
string
, optional
):
City,
state
(
string
, optional
):
State/Province,
postal_code
(
string
, optional
):
Zip/Postal Code,
county
(
string
, optional
):
County,
country
(
string
, optional
):
Country,
seasonal_from
(
string
, optional
):
Seasonal from (mm-dd),
seasonal_to
(
string
, optional
):
Seasonal to (mm-dd),
seasonal
(
boolean
, optional
):
Is seasonal?,
is_preferred
(
boolean
, optional
):
Is preferred address,
not_current
(
boolean
, optional
):
Not current?
}
WebAddress {
url
(
string
, optional
):
Web Address,
web_address_type_id
(
integer
, optional
):
Web Address Type ID,
web_address_type_name
(
string
, optional
):
Web Address Type Name,
is_preferred
(
boolean
, optional
):
Make this the preferred email address
}
CategoryAggregatedUpdate {
id
(
integer
, optional
):
Category Id,
name
(
string
, required
):
Name,
key
(
string
, optional
):
Key,
remove_previous_keywords
(
boolean
, optional
):
Remove previous category keywords,
keywords
(
array
, required
, KeywordAggregatedUpdate
):
Keyword Values
}
KeywordAggregatedUpdate {
id
(
integer
, required
):
Keyword Id,
name
(
string
, required
):
Name,
short_code
(
string
, optional
):
Short Code
}
GroupMembershipUpdate {
id
(
integer
, optional
):
ID,
group_id
(
integer
, required
):
Group Id,
group_name
(
string
, optional
):
Group Name,
date_start
(
date
, optional
):
Start Date,
date_end
(
date
, optional
):
End Date,
is_current
(
boolean
, optional
):
Current?
}
CustomAttr_create {
id
(
integer
, optional
):
Custom Field Id,
key
(
string
, optional
):
Key,
value
(
string
, required
):
Value
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959576Body:
|
Response:
|
DELETE /api/v1/constituents/{id} - Delete constituent
Delete the Constituent along with related objects.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Constituent Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959576Response:
|
ConstituentRelationship Management
GET /api/v1/constituents/{constituent_id}/constituent_relationships - Fetch Constituent Relationships for a Constituent
Lists all the constituent relationships for a constituent.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/constituent_relationshipsResponse:
|
POST /api/v1/constituents/{constituent_id}/constituent_relationships - Create new Constituent Relationship
Add constituent relationship.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| body | Create Objects | CreateBody | true | body |
CreateBody
|
CreateBody {
id
(
integer
, optional
):
ConstituentRelationship ID,
related_constituent_id
(
integer
, optional
):
Related Constituent ID,
relationship_type_id
(
integer
, optional
):
Relationship Type ID,
name
(
string
, optional
):
Relationship name,
description
(
string
, optional
):
Relationship description,
reciprocal_id
(
integer
, optional
):
Reciprocal Relationship Type ID,
rec_name
(
string
, optional
):
Reciprocal relationship name,
reciprocal_description
(
string
, optional
):
Reciprocal relationship description,
share_address
(
integer
, optional
):
Share address?,
share_phone
(
integer
, optional
):
Share phone?,
auto_soft_credit
(
boolean
, optional
):
Automatically soft credit?,
also_acknowledge
(
boolean
, optional
):
Send memorial acknowledgements?,
created_at
(
datetime
, optional
):
Created At date and time,
updated_at
(
datetime
, optional
):
Updated At date and time
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/constituent_relationshipsBody:
|
Response:
|
GET /api/v1/constituent_relationships/{id} - Show Constituent Relationship details
Show details for the constituent relationship.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Constituent Relationship Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituent_relationships/214491Response:
|
PATCH /api/v1/constituent_relationships/{id} - Update Constituent Relationship
Update the constituent relationship.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Constituent Relationship Id | integer | true | path |
| body | Update Objects | UpdateBody | true | body |
UpdateBody
|
UpdateBody {
id
(
integer
, optional
):
ConstituentRelationship ID,
related_constituent_id
(
integer
, optional
):
Related Constituent ID,
relationship_type_id
(
integer
, optional
):
Relationship Type ID,
name
(
string
, optional
):
Relationship name,
description
(
string
, optional
):
Relationship description,
reciprocal_id
(
integer
, optional
):
Reciprocal Relationship Type ID,
rec_name
(
string
, optional
):
Reciprocal relationship name,
reciprocal_description
(
string
, optional
):
Reciprocal relationship description,
share_address
(
integer
, optional
):
Share address?,
share_phone
(
integer
, optional
):
Share phone?,
auto_soft_credit
(
boolean
, optional
):
Automatically soft credit?,
also_acknowledge
(
boolean
, optional
):
Send memorial acknowledgements?,
created_at
(
datetime
, optional
):
Created At date and time,
updated_at
(
datetime
, optional
):
Updated At date and time
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituent_relationships/214513Body:
|
Response:
|
DELETE /api/v1/constituent_relationships/{id} - Delete Constituent Relationship
Delete the constituent relationship.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Constituent Relationship Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituent_relationships/214513Response:
|
Contact Reports Management
GET /api/v1/constituents/{constituent_id}/contact_reports - Fetch Contact Reports for Constituent
Lists all the contact reports for a constituent.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/contact_reportsResponse:
|
POST /api/v1/constituents/{constituent_id}/contact_reports - Create new Contact Report
Add contact report.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| body | Create Objects | CreateBody | true | body |
CreateBody
|
CreateBody {
name
(
string
, optional
):
Name,
contact_report_type_id
(
integer
, optional
):
Contact Report Type Id,
contact_report_type_name
(
string
, optional
):
Contact Report Type Name,
original_date
(
date
, optional
):
Original Date,
text
(
string
, required
):
Text,
team_member
(
string
, optional
):
Team Member ('id', 'email', or 'first_name last_name')
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/contact_reportsBody:
|
Response:
|
GET /api/v1/contact_reports/search - Search for Contact Reports
Search for active contact reports| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| q[] | Query String. (EX: updated_from=2016-01-01) | string | true | query |
| sort | Sort by one of the following fields: 'name, date, constituent_id'. Add an exclamation point to reverse the order. (EX: sort=name!) | string | query | |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Available Search Terms:
| Original Date | original_date_from | Date updated from (YYYY-MM-DDTHH:MM:SSZ) |
| original_date_to | Date updated to (YYYY-MM-DDTHH:MM:SSZ) | |
| Name | name | Name contains string |
| Text | text | Text contains string |
| Contact Report Type | contact_report_type_id | Comma separated contact_report_type_ids |
| Constituent Id | constituent_id | Comma separated constituent_ids |
| Constituent Keyword | const_keyword | Comma separated Constituent keyword_ids |
| Updated At | updated_from | Date updated from (YYYY-MM-DDTHH:MM:SSZ) |
| updated_to | Date updated to (YYYY-MM-DDTHH:MM:SSZ) |
Note: Multiple terms may be combined using a semi-colon: "updated_from=2018-05-04;updated_to=2018-05-04"
Example - Search by Name:
URI: https://api.littlegreenlight.com/api/v1/contact_reports/searchQuery:
q[]=name=Dinner&limit=5 |
Response:
|
Example - Search by Constituent Keyword and Updated Since:
URI: https://api.littlegreenlight.com/api/v1/contact_reports/searchQuery:
q[]=const_keyword=12221;updated_from=2016-01-01&limit=5 |
Response:
|
GET /api/v1/contact_reports - Fetch Contact Reports for Account
Lists all the contact reports for an account.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/contact_reportsResponse:
|
GET /api/v1/contact_reports/{id} - Show Contact Report details
Show details for the contact report.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Contact Report Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/contact_reports/9930Response:
|
PATCH /api/v1/contact_reports/{id} - Update Contact Report
Update the contact report.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Contact Report Id | integer | true | path |
| body | Update Objects | UpdateBody | true | body |
UpdateBody
|
UpdateBody {
constituent_id
(
integer
, optional
):
Constituent Id,
name
(
string
, optional
):
Name,
contact_report_type_id
(
integer
, optional
):
Contact Report Type Id,
contact_report_type_name
(
string
, optional
):
Contact Report Type Name,
original_date
(
date
, optional
):
Original Date,
text
(
string
, required
):
Text,
team_member
(
string
, optional
):
Team Member ('id', 'email', or 'first_name last_name')
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/contact_reports/9930Body:
|
Response:
|
DELETE /api/v1/contact_reports/{id} - Delete Contact Report
Delete the contact report.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Contact Report Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/contact_reports/9930Response:
|
Custom Attributes Management
GET /api/v1/attributes - Fetch Custom Attributes
Lists custom attributes..| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| item_type | Attributes for type (default: Constituent). Available: Constituent, Invitation | string | query | |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Email Address Management
GET /api/v1/constituents/{constituent_id}/email_addresses - Fetch Email Addresses
Lists all the email addresses.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/email_addressesResponse:
|
POST /api/v1/constituents/{constituent_id}/email_addresses - Create new Email Address
Add email address.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| body | Create Objects | CreateBody | true | body |
CreateBody
|
CreateBody {
address
(
string
, optional
):
Email Address,
email_address_type_id
(
integer
, optional
):
Email Address Type ID,
email_type_name
(
string
, optional
):
Email Address Type Name,
is_preferred
(
boolean
, optional
):
Make this the preferred email address,
not_current
(
boolean
, optional
):
No longer a current email address
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/email_addressesBody:
|
Response:
|
GET /api/v1/email_addresses/{id} - Show Email Address details
Show details for the email address.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Email Address Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/email_addresses/276464Response:
|
PATCH /api/v1/email_addresses/{id} - Update Email Address
Update the email address.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Email Address Id | integer | true | path |
| body | Update Objects | UpdateBody | true | body |
UpdateBody
|
UpdateBody {
address
(
string
, optional
):
Email Address,
email_address_type_id
(
integer
, optional
):
Email Address Type ID,
email_type_name
(
string
, optional
):
Email Address Type Name,
is_preferred
(
boolean
, optional
):
Make this the preferred email address,
not_current
(
boolean
, optional
):
No longer a current email address
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/email_addresses/276616Body:
|
Response:
|
DELETE /api/v1/email_addresses/{id} - Delete Email Address
Delete the email address.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Email Address Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/email_addresses/276616Response:
|
Events Management
GET /api/v1/events - Fetch Events
Lists all the events.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/eventsQuery:
limit=5 |
Response:
|
Funds Management
GET /api/v1/funds - Fetch Funds
Lists all the funds.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/fundsQuery:
limit=5 |
Response:
|
Gift Category Management
GET /api/v1/gift_categories - Fetch Gift Categories
Lists all the gift categories.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| gift_type_id | Gift type ID | string | query | |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/gift_categoriesQuery:
limit=5 |
Response:
|
Gift Type Management
GET /api/v1/gift_types - Fetch Gift Types
Lists all the gift types.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/gift_typesQuery:
limit=5 |
Response:
|
Gifts Management
GET /api/v1/constituents/{constituent_id}/gifts - Fetch Gifts
Lists all the gifts.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example - Fetch Gifts for a Constituent:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/giftsResponse:
|
POST /api/v1/constituents/{constituent_id}/gifts - Create new Gift
Add gift.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| body | Create Objects | CreateBody | true | body |
CreateBody
|
CreateBody {
external_id
(
integer
, optional
):
External Gift ID,
is_anon
(
boolean
, optional
):
Gift is Anonymous?,
gift_type_id
(
integer
, required
):
Gift type ID,
gift_type_name
(
string
, required
):
Gift type name,
gift_category_id
(
integer
, optional
):
Gift category ID,
gift_category_name
(
string
, optional
):
Gift category name,
campaign_id
(
integer
, optional
):
Campaign ID,
campaign_name
(
string
, optional
):
Campaign name,
fund_id
(
integer
, optional
):
Fund ID,
fund_name
(
string
, optional
):
Fund name,
appeal_id
(
integer
, optional
):
Appeal ID,
appeal_name
(
string
, optional
):
Appeal name,
event_id
(
integer
, optional
):
Event ID,
event_name
(
string
, optional
):
Event name,
received_amount
(
double
, optional
):
Gift amount,
received_date
(
date
, optional
):
Gift date,
payment_type_id
(
integer
, optional
):
Payment type ID,
payment_type_name
(
string
, optional
):
Payment type name,
check_number
(
string
, optional
):
Check/Reference No.,
deductible_amount
(
double
, optional
):
Tax deductible amount,
note
(
string
, optional
):
Gift note,
ack_template_name
(
string
, optional
):
Ack. mailing template name. (use 'do_not_ack' to indicate no acknowledgment),
deposit_date
(
date
, optional
):
Deposit Date,
deposited_amount
(
double
, optional
):
Deposit Amount,
parent_gift_id
(
integer
, optional
):
LGL parent gift ID,
parent_external_id
(
integer
, optional
):
External parent gift ID,
auto_sync_to_qbo
(
boolean
, optional
):
Auto Sync to QBO (only for active QuickBooks integrations),
tribute_name
(
string
, optional
):
The name of tribute. Values: "Honorary - General", "Memorial - General", or a pre-defined named tribute,
tributee_name
(
string
, optional
):
The name of the honoree/deceased,
tribute_dedication
(
string
, optional
):
The tribute dedication note/text for a gift,
tribute_recipient_name
(
string
, optional
):
The name of person who should be notified about this tribute gift.,
tribute_recipient_salutation
(
string
, optional
):
The name of person who should be notified about this tribute gift.,
tribute_recipient_email
(
string
, optional
):
The email of the person who should be notified about this tribute gift.,
tribute_recipient_address
(
string
, optional
):
The address of the person who should be notified about this tribute gift.,
tribute_recipient_notification_template
(
string
, optional
):
The notification template to be used for the person who should be notified about this tribute gift.,
team_member
(
string
, optional
):
Team Member ('id', 'email', or 'first_name last_name'),
custom_fields
(
array
, optional
, CustomFieldAggregatedUpdate
):
Gift custom fields (Categories)
}
CustomFieldAggregatedUpdate {
id
(
integer
, optional
):
Custom Field Id,
name
(
string
, required
):
Name,
key
(
string
, optional
):
Key,
remove_previous_values
(
boolean
, optional
):
Remove previous field values,
values
(
array
, required
, CustomValueAggregatedUpdate
):
Values
}
CustomValueAggregatedUpdate {
id
(
integer
, required
):
Value Id,
name
(
string
, required
):
Name
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example - Create Gift with Custom Field:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/giftsBody:
|
Response:
|
Example - Create Gift with Tribute:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/giftsBody:
|
Response:
|
GET /api/v1/gifts/search - Search for Gifts
Search for active gifts| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| q[] | Query String. (EX: updated_from=2016-01-01) | string | true | query |
| expand | Expand requested, comma separated, data structures: 'external_constituent_id, first_name, last_name, org_name, phone_numbers, email_addresses, street_addresses' | string | query | |
| sort | Sort by one of the following fields: 'name, gift_amount, date, date_created, date_updated, fund, appeal, campaign, gift_type'. Add an exclamation point to reverse the order. (EX: sort=name!) | string | query | |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Available Search Terms:
| Gift Date | date_from | "YYYY-MM-DD" |
| date_to | "YYYY-MM-DD" | |
| Gift Types | gift_types | "op|comma sep type IDs" |
| operators: in,ni | ||
| Amount | gift_amount | "op|number[|number2]" |
| operators: gte,lte,btw,gt,lt,eq,ne | ||
| Payment Types | payment_types | "op|comma sep type IDs" |
| operators: in,ni,bl | ||
| Campaigns | campaigns | "op|comma sep campaign IDs" |
| operators: in,ni,bl | ||
| Funds | funds | "op|comma sep fund IDs" |
| operators: in,ni,bl | ||
| Appeals | appeals | "op|comma sep appeal IDs" |
| operators: in,ni,bl | ||
| Appeal Type | appeal_types | "op|comma sep type IDs" |
| operators: in,ni | ||
| Events | events | "op|comma sep event IDs" |
| operators: in,ni,bl | ||
| Event Type | event_types | "op|comma sep type IDs" |
| operators: in,ni | ||
| Gift Categories | categories | "op|comma sep cat IDs" |
| operators: in,ni,bl | ||
| Gift IDs | gift_ids | "comma sep gift IDs" |
| External Gift IDs | external_gift_ids | "comma sep ext gift IDs" |
| Creation Date | created_from | Date created from (YYYY-MM-DDTHH:MM:SSZ) |
| created_to | Date created to (YYYY-MM-DDTHH:MM:SSZ) | |
| Updated Date | updated_from | Date updated from (YYYY-MM-DDTHH:MM:SSZ) |
| updated_to | Date updated to (YYYY-MM-DDTHH:MM:SSZ) |
Note: Multiple terms may be combined using a semi-colon: "updated_from=2018-05-04;updated_to=2018-05-04"
Example - Search by Between Amounts:
URI: https://api.littlegreenlight.com/api/v1/gifts/searchQuery:
q[]=gift_amount=btw|100|1000&limit=5 |
Response:
|
Example - Search by Gift Types and Updated Since, Sort by Date Updated:
URI: https://api.littlegreenlight.com/api/v1/gifts/searchQuery:
q[]=gift_types=in|1,7;updated_from=2023-01-01&sort=date_updated!&limit=5 |
Response:
|
Example - Search by Gift Types and Updated Since, Expand First Name, Last Name, Org Name, Address, Phone, and Email Records:
URI: https://api.littlegreenlight.com/api/v1/gifts/searchQuery:
q[]=gift_types=in|1,7;updated_from=2023-01-01&expand=first_name, last_name, org_name, street_addresses, phone_numbers, email_addresses&limit=3 |
Response:
|
GET /api/v1/gifts/{id} - Show Gift details
Show details for the gift.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Gift Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/gifts/894772Response:
|
PATCH /api/v1/gifts/{id} - Update Gift
Update the gift.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Gift Id | integer | true | path |
| body | Update Objects | UpdateBody | true | body |
UpdateBody
|
UpdateBody {
external_id
(
integer
, optional
):
External Gift ID,
is_anon
(
boolean
, optional
):
Gift is Anonymous?,
gift_type_id
(
integer
, required
):
Gift type ID,
gift_type_name
(
string
, required
):
Gift type name,
gift_category_id
(
integer
, optional
):
Gift category ID,
gift_category_name
(
string
, optional
):
Gift category name,
campaign_id
(
integer
, optional
):
Campaign ID,
campaign_name
(
string
, optional
):
Campaign name,
fund_id
(
integer
, optional
):
Fund ID,
fund_name
(
string
, optional
):
Fund name,
appeal_id
(
integer
, optional
):
Appeal ID,
appeal_name
(
string
, optional
):
Appeal name,
event_id
(
integer
, optional
):
Event ID,
event_name
(
string
, optional
):
Event name,
received_amount
(
double
, optional
):
Gift amount,
received_date
(
date
, optional
):
Gift date,
payment_type_id
(
integer
, optional
):
Payment type ID,
payment_type_name
(
string
, optional
):
Payment type name,
check_number
(
string
, optional
):
Check/Reference No.,
deductible_amount
(
double
, optional
):
Tax deductible amount,
note
(
string
, optional
):
Gift note,
ack_template_name
(
string
, optional
):
Ack. mailing template name. (use 'do_not_ack' to indicate no acknowledgment),
deposit_date
(
date
, optional
):
Deposit Date,
deposited_amount
(
double
, optional
):
Deposit Amount,
parent_gift_id
(
integer
, optional
):
LGL parent gift ID,
parent_external_id
(
integer
, optional
):
External parent gift ID,
auto_sync_to_qbo
(
boolean
, optional
):
Auto Sync to QBO (only for active QuickBooks integrations),
tribute_name
(
string
, optional
):
The name of tribute. Values: "Honorary - General", "Memorial - General", or a pre-defined named tribute,
tributee_name
(
string
, optional
):
The name of the honoree/deceased,
tribute_dedication
(
string
, optional
):
The tribute dedication note/text for a gift,
tribute_recipient_name
(
string
, optional
):
The name of person who should be notified about this tribute gift.,
tribute_recipient_salutation
(
string
, optional
):
The name of person who should be notified about this tribute gift.,
tribute_recipient_email
(
string
, optional
):
The email of the person who should be notified about this tribute gift.,
tribute_recipient_address
(
string
, optional
):
The address of the person who should be notified about this tribute gift.,
tribute_recipient_notification_template
(
string
, optional
):
The notification template to be used for the person who should be notified about this tribute gift.,
team_member
(
string
, optional
):
Team Member ('id', 'email', or 'first_name last_name'),
custom_fields
(
array
, optional
, CustomFieldAggregatedUpdate
):
Gift custom fields (Categories)
}
CustomFieldAggregatedUpdate {
id
(
integer
, optional
):
Custom Field Id,
name
(
string
, required
):
Name,
key
(
string
, optional
):
Key,
remove_previous_values
(
boolean
, optional
):
Remove previous field values,
values
(
array
, required
, CustomValueAggregatedUpdate
):
Values
}
CustomValueAggregatedUpdate {
id
(
integer
, required
):
Value Id,
name
(
string
, required
):
Name
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example - Add Event and Custom Field Value:
URI: https://api.littlegreenlight.com/api/v1/gifts/894772Body:
|
Response:
|
Example - Replace Previous Custom Field Values with New Value:
URI: https://api.littlegreenlight.com/api/v1/gifts/894772Body:
|
Response:
|
DELETE /api/v1/gifts/{id} - Delete Gift
Delete the gift.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Gift Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/gifts/894772Response:
|
Example:
URI: https://api.littlegreenlight.com/api/v1/gifts/894773Response:
|
Group Memberships Management
GET /api/v1/group_memberships/{id} - Show Group Membership details
Show details for the group membership.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Group Membership Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/group_memberships/595510Response:
|
PATCH /api/v1/group_memberships/{id} - Update Group Membership
Update the group membership.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Group Membership Id | integer | true | path |
| body | Update Objects | UpdateBody | true | body |
UpdateBody
|
UpdateBody {
constituent_id
(
integer
, optional
):
Constituent Id,
group_id
(
integer
, required
):
Group Id,
group_name
(
string
, optional
):
Group Name,
date_start
(
date
, optional
):
Start Date,
date_end
(
date
, optional
):
End Date,
is_current
(
boolean
, optional
):
Current?
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/group_memberships/595510Body:
|
Response:
|
DELETE /api/v1/group_memberships/{id} - Delete Group Membership
Delete the group membership.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Group Membership Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/group_memberships/595510Response:
|
GET /api/v1/constituents/{constituent_id}/group_memberships - Fetch Group Memberships
Lists all the group memberships.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/group_membershipsResponse:
|
POST /api/v1/constituents/{constituent_id}/group_memberships - Create new Group Membership
Add group membership.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| body | Create Objects | CreateBody | true | body |
CreateBody
|
CreateBody {
group_id
(
integer
, required
):
Group Id,
group_name
(
string
, optional
):
Group Name,
date_start
(
date
, optional
):
Start Date,
date_end
(
date
, optional
):
End Date,
is_current
(
boolean
, optional
):
Current?
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Groups Management
GET /api/v1/groups - Fetch Groups
Lists all the groups.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/groupsResponse:
|
POST /api/v1/groups - Create new Group
Add group.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| body | Create Objects | CreateBody | true | body |
CreateBody
|
CreateBody {
name
(
string
, required
):
Name,
key
(
string
, optional
):
Key,
ordinal
(
integer
, optional
):
Ordinal
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/groupsBody:
|
Response:
|
GET /api/v1/groups/{id} - Show Group details
Show details for the group.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Group Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/groups/3299Response:
|
PATCH /api/v1/groups/{id} - Update Group
Update the group.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Group Id | integer | true | path |
| body | Update Objects | UpdateBody | true | body |
UpdateBody
|
UpdateBody {
name
(
string
, required
):
Name,
key
(
string
, optional
):
Key,
ordinal
(
integer
, optional
):
Ordinal
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/groups/3299Body:
|
Response:
|
DELETE /api/v1/groups/{id} - Delete Group
Delete the group.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Group Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/groups/3299Response:
|
Invitations Management
POST /api/v1/constituents/{constituent_id}/invitations - Create new Invitation for Constituent
Add invitation to constituent.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| body | Create Objects | CreateBody_Const | true | body |
CreateBody_Const
|
CreateBody_Const {
event_id
(
integer
, required
):
Event Id,
parent_invitation_id
(
integer
, optional
):
Parent Invitation Id (for additional guests),
notes
(
string
, optional
):
Notes,
rsvp
(
integer
, optional
):
RSVP (1-Yes, 2-No, 3-Maybe, 4-Unknown),
attended
(
integer
, optional
):
Attended,
assigned_to
(
integer
, optional
):
Assigned to,
attendee_names
(
string
, optional
):
Attendees Names,
guest_first_name
(
string
, optional
):
Additional Guest First Name,
guest_last_name
(
string
, optional
):
Additional Guest Last Name,
is_a_guest
(
boolean
, optional
):
Creating an additional guest record,
attendances
(
array
, optional
, Attendance_create
):
Multiple attendances,
custom_fields
(
array
, optional
, CustomFieldAggregatedUpdate
):
Invitation custom fields (Categories),
custom_attrs
(
array
, optional
, CustomAttr_create
):
Invitation custom attributes
}
Attendance_create {
date
(
date
, required
):
Attendance date,
notes
(
string
, optional
):
Attendance notes
}
CustomFieldAggregatedUpdate {
id
(
integer
, optional
):
Custom Field Id,
name
(
string
, required
):
Name,
key
(
string
, optional
):
Key,
remove_previous_values
(
boolean
, optional
):
Remove previous field values,
values
(
array
, required
, CustomValueAggregatedUpdate
):
Values
}
CustomValueAggregatedUpdate {
id
(
integer
, required
):
Value Id,
name
(
string
, required
):
Name
}
CustomAttr_create {
id
(
integer
, optional
):
Custom Field Id,
key
(
string
, optional
):
Key,
value
(
string
, required
):
Value
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/invitationsBody:
|
Response:
|
GET /api/v1/constituents/{constituent_id}/invitations - Fetch Invitations for Constituent
Lists all the invitations for a constituent.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/invitationsQuery:
limit=5 |
Response:
|
GET /api/v1/events/{event_id}/invitations - Fetch Invitations for Event
Lists all the invitations for an event.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| event_id | Event Id | integer | true | path |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/events/1069/invitationsQuery:
limit=5 |
Response:
|
POST /api/v1/events/{event_id}/invitations - Create new Invitation
Add invitation.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| event_id | Event Id | integer | true | path |
| body | Create Objects | CreateBody | true | body |
CreateBody
|
CreateBody {
constituent_id
(
integer
, required
):
Constituent Id,
parent_invitation_id
(
integer
, optional
):
Parent Invitation Id (for additional guests),
notes
(
string
, optional
):
Notes,
rsvp
(
integer
, optional
):
RSVP (1-Yes, 2-No, 3-Maybe, 4-Unknown),
attended
(
integer
, optional
):
Attended,
assigned_to
(
integer
, optional
):
Assigned to,
attendee_names
(
string
, optional
):
Attendees Names,
guest_first_name
(
string
, optional
):
Additional Guest First Name,
guest_last_name
(
string
, optional
):
Additional Guest Last Name,
is_a_guest
(
boolean
, optional
):
Creating an additional guest record,
attendances
(
array
, optional
, Attendance_create
):
Multiple attendances,
custom_fields
(
array
, optional
, CustomFieldAggregatedUpdate
):
Invitation custom fields (Categories),
custom_attrs
(
array
, optional
, CustomAttr_create
):
Invitation custom attributes
}
Attendance_create {
date
(
date
, required
):
Attendance date,
notes
(
string
, optional
):
Attendance notes
}
CustomFieldAggregatedUpdate {
id
(
integer
, optional
):
Custom Field Id,
name
(
string
, required
):
Name,
key
(
string
, optional
):
Key,
remove_previous_values
(
boolean
, optional
):
Remove previous field values,
values
(
array
, required
, CustomValueAggregatedUpdate
):
Values
}
CustomValueAggregatedUpdate {
id
(
integer
, required
):
Value Id,
name
(
string
, required
):
Name
}
CustomAttr_create {
id
(
integer
, optional
):
Custom Field Id,
key
(
string
, optional
):
Key,
value
(
string
, required
):
Value
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example - Create invitation for an event:
URI: https://api.littlegreenlight.com/api/v1/events/1070/invitationsBody:
|
Response:
|
Example - Create an additional guest for an invitation:
URI: https://api.littlegreenlight.com/api/v1/events/1069/invitationsBody:
|
Response:
|
GET /api/v1/invitations/{id} - Show Invitation details
Show details for the invitation.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Invitation Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/invitations/168363Response:
|
PATCH /api/v1/invitations/{id} - Update Invitation
Update the invitation.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Invitation Id | integer | true | path |
| body | Update Objects | UpdateBody | true | body |
UpdateBody
|
UpdateBody {
constituent_id
(
integer
, required
):
Constituent Id,
parent_invitation_id
(
integer
, optional
):
Parent Invitation Id (for additional guests),
notes
(
string
, optional
):
Notes,
rsvp
(
integer
, optional
):
RSVP (1-Yes, 2-No, 3-Maybe, 4-Unknown),
attended
(
integer
, optional
):
Attended,
assigned_to
(
integer
, optional
):
Assigned to,
attendee_names
(
string
, optional
):
Attendees Names,
guest_first_name
(
string
, optional
):
Additional Guest First Name,
guest_last_name
(
string
, optional
):
Additional Guest Last Name,
is_a_guest
(
boolean
, optional
):
Creating an additional guest record,
attendances
(
array
, optional
, Attendance_create
):
Multiple attendances,
custom_fields
(
array
, optional
, CustomFieldAggregatedUpdate
):
Invitation custom fields (Categories),
custom_attrs
(
array
, optional
, CustomAttr_create
):
Invitation custom attributes
}
Attendance_create {
date
(
date
, required
):
Attendance date,
notes
(
string
, optional
):
Attendance notes
}
CustomFieldAggregatedUpdate {
id
(
integer
, optional
):
Custom Field Id,
name
(
string
, required
):
Name,
key
(
string
, optional
):
Key,
remove_previous_values
(
boolean
, optional
):
Remove previous field values,
values
(
array
, required
, CustomValueAggregatedUpdate
):
Values
}
CustomValueAggregatedUpdate {
id
(
integer
, required
):
Value Id,
name
(
string
, required
):
Name
}
CustomAttr_create {
id
(
integer
, optional
):
Custom Field Id,
key
(
string
, optional
):
Key,
value
(
string
, required
):
Value
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/invitations/168364Body:
|
Response:
|
DELETE /api/v1/invitations/{id} - Delete Invitation
Delete the invitation.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Invitation Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/invitations/168363Response:
|
Example:
URI: https://api.littlegreenlight.com/api/v1/invitations/168364Response:
|
Keyword Management
GET /api/v1/categories/{category_id}/keywords - Fetch Keywords
Lists all the keywords.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| category_id | Category Id | integer | true | path |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/categories/1042/keywordsResponse:
|
POST /api/v1/categories/{category_id}/keywords - Create new Keyword
Add keyword.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| category_id | Category Id | integer | true | path |
| body | Create Objects | CreateBody | true | body |
CreateBody
|
CreateBody {
category_id
(
integer
, required
):
Category Id,
name
(
string
, required
):
Name,
description
(
string
, optional
):
Description,
short_code
(
string
, optional
):
Short Code,
ordinal
(
integer
, optional
):
Ordinal,
removable
(
boolean
, optional
):
Removable?,
can_change
(
boolean
, optional
):
Can Change?,
can_select
(
boolean
, optional
):
Can Select?
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/categories/1042/keywordsBody:
|
Response:
|
Example:
URI: https://api.littlegreenlight.com/api/v1/categories/1042/keywordsBody:
|
Response:
|
POST /api/v1/constituents/{constituent_id}/keywords - Add Keyword
Add a keyword to a constituent.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| body | Add Keyword | AddBody | true | body |
AddBody
|
AddBody {
id
(
integer
, required
):
Keyword Id
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok | |
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/keywordsBody:
|
Response:
|
DELETE /api/v1/constituents/{constituent_id}/keywords/{id} - Remove Keyword
Remove a keyword from a constituent| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Keyword Id | integer | true | path |
| constituent_id | Constituent Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/keywords/12345Response:
|
GET /api/v1/keywords/{id} - Show Keyword details
Show details for the keyword.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Keyword Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/keywords/12225Response:
|
PATCH /api/v1/keywords/{id} - Update Keyword
Update the keyword.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Keyword Id | integer | true | path |
| body | Update Objects | UpdateBody | true | body |
UpdateBody
|
UpdateBody {
category_id
(
integer
, required
):
Category Id,
name
(
string
, required
):
Name,
description
(
string
, optional
):
Description,
short_code
(
string
, optional
):
Short Code,
ordinal
(
integer
, optional
):
Ordinal,
removable
(
boolean
, optional
):
Removable?,
can_change
(
boolean
, optional
):
Can Change?,
can_select
(
boolean
, optional
):
Can Select?
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/keywords/12344Body:
|
Response:
|
DELETE /api/v1/keywords/{id} - Delete Keyword
Delete the keyword.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Keyword Id | integer | true | path |
| permanent | Delete permantently. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/keywords/12344Response:
|
Example:
URI: https://api.littlegreenlight.com/api/v1/keywords/12344Query:
permanent=1 |
Response:
|
Example:
URI: https://api.littlegreenlight.com/api/v1/keywords/12345Query:
permanent=1 |
Response:
|
Mailing Templates Management
GET /api/v1/mailing_templates - Fetch Mailing Templates
Lists all the mailing templates.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| mailing_type_id | Mailing type ID | string | query | |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/mailing_templatesQuery:
mailing_type_id=1907&limit=5 |
Response:
|
Membership Levels Management
GET /api/v1/membership_levels - Fetch Membership Levels
Lists all the membership levels.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/membership_levelsResponse:
|
POST /api/v1/membership_levels - Create new Membership Level
Add membership level.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| body | Create Objects | CreateBody | true | body |
CreateBody
|
CreateBody {
name
(
string
, required
):
Name,
ordinal
(
integer
, optional
):
Ordinal
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/membership_levelsBody:
|
Response:
|
GET /api/v1/membership_levels/{id} - Show Membership Level details
Show details for the membership level.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Membership Level Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/membership_levels/447Response:
|
PATCH /api/v1/membership_levels/{id} - Update Membership Level
Update the membership level.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Membership Level Id | integer | true | path |
| body | Update Objects | UpdateBody | true | body |
UpdateBody
|
UpdateBody {
name
(
string
, required
):
Name,
ordinal
(
integer
, optional
):
Ordinal
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/membership_levels/447Body:
|
Response:
|
DELETE /api/v1/membership_levels/{id} - Delete Membership Level
Delete the membership level.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Membership Level Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/membership_levels/447Response:
|
Membership Management
GET /api/v1/constituents/{constituent_id}/memberships - Fetch Memberships
Lists all the memberships.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/membershipsResponse:
|
POST /api/v1/constituents/{constituent_id}/memberships - Create new Membership
Add membership.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| body | Create Objects | CreateBody | true | body |
CreateBody
|
CreateBody {
membership_level_id
(
integer
, optional
):
Membership Level ID,
membership_level_name
(
string
, optional
):
Membership Level Name,
date_start
(
date
, optional
):
Date start,
finish_date
(
date
, optional
):
Date end,
note
(
string
, optional
):
Note
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/membershipsBody:
|
Response:
|
GET /api/v1/memberships/{id} - Show Membership details
Show details for the membership.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Membership Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/memberships/483Response:
|
PATCH /api/v1/memberships/{id} - Update Membership
Update the membership.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Membership Id | integer | true | path |
| body | Update Objects | UpdateBody | true | body |
UpdateBody
|
UpdateBody {
membership_level_id
(
integer
, optional
):
Membership Level ID,
membership_level_name
(
string
, optional
):
Membership Level Name,
date_start
(
date
, optional
):
Date start,
finish_date
(
date
, optional
):
Date end,
note
(
string
, optional
):
Note
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/memberships/483Body:
|
Response:
|
DELETE /api/v1/memberships/{id} - Delete Membership
Delete the membership.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Membership Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/memberships/483Response:
|
Payment Types Management
GET /api/v1/payment_types - Fetch Payment Types
Lists all the payment types.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/payment_typesQuery:
limit=5 |
Response:
|
Phone Number Management
GET /api/v1/constituents/{constituent_id}/phone_numbers - Fetch Phone Numbers
Lists all the phone numbers.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/phone_numbersResponse:
|
POST /api/v1/constituents/{constituent_id}/phone_numbers - Create new Phone Number
Add phone number.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| body | Create Objects | CreateBody | true | body |
CreateBody
|
CreateBody {
number
(
string
, optional
):
Phone Number,
phone_number_type_id
(
integer
, optional
):
Phone Number Type Id,
phone_type_name
(
string
, optional
):
Phone Number Type Name,
is_preferred
(
boolean
, optional
):
Make this the preferred phone number,
not_current
(
boolean
, optional
):
No longer a current phone number
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/phone_numbersBody:
|
Response:
|
GET /api/v1/phone_numbers/{id} - Show Phone Number details
Show details for the phone number.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Phone Number Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/phone_numbers/479723Response:
|
PATCH /api/v1/phone_numbers/{id} - Update Phone Number
Update the phone number.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Phone Number Id | integer | true | path |
| body | Update Objects | UpdateBody | true | body |
UpdateBody
|
UpdateBody {
number
(
string
, optional
):
Phone Number,
phone_number_type_id
(
integer
, optional
):
Phone Number Type Id,
phone_type_name
(
string
, optional
):
Phone Number Type Name,
is_preferred
(
boolean
, optional
):
Make this the preferred phone number,
not_current
(
boolean
, optional
):
No longer a current phone number
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/phone_numbers/479723Body:
|
Response:
|
DELETE /api/v1/phone_numbers/{id} - Delete Phone Number
Delete the phone number.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Phone Number Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/phone_numbers/479723Response:
|
RelationshipType Management
GET /api/v1/relationship_types - Fetch Relationship Types
Lists all the relationship types.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/relationship_typesQuery:
limit=5 |
Response:
|
Street Address Management
GET /api/v1/constituents/{constituent_id}/street_addresses - Fetch Street Addresses
Lists all the street addresses.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/street_addressesResponse:
|
POST /api/v1/constituents/{constituent_id}/street_addresses - Create new Street Address
Add street address.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| body | Create Objects | CreateBody | true | body |
CreateBody
|
CreateBody {
street
(
string
, optional
):
Street,
street_address_type_id
(
integer
, optional
):
Street Address Type ID,
street_type_name
(
string
, optional
):
Street Address Type Name,
city
(
string
, optional
):
City,
state
(
string
, optional
):
State/Province,
postal_code
(
string
, optional
):
Zip/Postal Code,
county
(
string
, optional
):
County,
country
(
string
, optional
):
Country,
seasonal_from
(
string
, optional
):
Seasonal from (mm-dd),
seasonal_to
(
string
, optional
):
Seasonal to (mm-dd),
seasonal
(
boolean
, optional
):
Is seasonal?,
is_preferred
(
boolean
, optional
):
Is preferred address,
not_current
(
boolean
, optional
):
Not current?
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/street_addressesBody:
|
Response:
|
GET /api/v1/street_addresses/{id} - Show Street Address details
Show details for the street address.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Street Address Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/street_addresses/838531Response:
|
PATCH /api/v1/street_addresses/{id} - Update Street Address
Update the street address.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Street Address Id | integer | true | path |
| body | Update Objects | UpdateBody | true | body |
UpdateBody
|
UpdateBody {
street
(
string
, optional
):
Street,
street_address_type_id
(
integer
, optional
):
Street Address Type ID,
street_type_name
(
string
, optional
):
Street Address Type Name,
city
(
string
, optional
):
City,
state
(
string
, optional
):
State/Province,
postal_code
(
string
, optional
):
Zip/Postal Code,
county
(
string
, optional
):
County,
country
(
string
, optional
):
Country,
seasonal_from
(
string
, optional
):
Seasonal from (mm-dd),
seasonal_to
(
string
, optional
):
Seasonal to (mm-dd),
seasonal
(
boolean
, optional
):
Is seasonal?,
is_preferred
(
boolean
, optional
):
Is preferred address,
not_current
(
boolean
, optional
):
Not current?
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/street_addresses/838531Body:
|
Response:
|
DELETE /api/v1/street_addresses/{id} - Delete Street Address
Delete the street address.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Street Address Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/street_addresses/838531Response:
|
Team Members Management
GET /api/v1/team_members - Fetch Team Members
Lists all the team members.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/team_membersQuery:
limit=5 |
Response:
|
Type Management
GET /api/v1/types - Fetch Types for Account
Lists all the types for an account.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/typesResponse:
|
GET /api/v1/types/{type} - Fetch Values for Type
Lists all the values for a type.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| type | Type: [ contact_report_types | email_address_types | mailing_types | street_address_types | phone_number_types | web_address_types | volunteering_categories | appeal_types | event_types ] | string | true | path |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/types/email_address_typesResponse:
|
Volunteer Time Management
GET /api/v1/constituents/{constituent_id}/volunteer_times - Fetch Volunteer Times for Constituent
Lists all the volunteer times for a constituent.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/volunteer_timesResponse:
|
POST /api/v1/constituents/{constituent_id}/volunteer_times - Create new Volunteer Time
Add volunteer time.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| body | Create Objects | CreateBody | true | body |
CreateBody
|
CreateBody {
constituent_id
(
integer
, required
):
Constituent ID,
external_id
(
integer
, optional
):
External Volunteering ID,
volunteering_category_id
(
integer
, required
):
Volunteer Category Id,
volunteering_category_name
(
string
, optional
):
Volunteer Category Name,
description
(
string
, optional
):
Description,
hours
(
double
, optional
):
Hours,
date
(
date
, optional
):
Date,
end_date
(
date
, optional
):
End Date,
completed_hours
(
double
, optional
):
Completed Hours,
custom_fields
(
array
, optional
, CustomFieldAggregatedUpdate
):
VolunteerTime custom fields (Categories)
}
CustomFieldAggregatedUpdate {
id
(
integer
, optional
):
Custom Field Id,
name
(
string
, required
):
Name,
key
(
string
, optional
):
Key,
remove_previous_values
(
boolean
, optional
):
Remove previous field values,
values
(
array
, required
, CustomValueAggregatedUpdate
):
Values
}
CustomValueAggregatedUpdate {
id
(
integer
, required
):
Value Id,
name
(
string
, required
):
Name
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/volunteer_timesBody:
|
Response:
|
GET /api/v1/volunteer_times/search - Search for Volunteer Times
Search for active volunteer times| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| q[] | Query String. (EX: updated_from=2016-01-01) | string | true | query |
| sort | Sort by one of the following fields: 'date, constituent_id'. Add an exclamation point to reverse the order. (EX: sort=name!) | string | query | |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Available Search Terms:
| Date | date_from | Date updated from (YYYY-MM-DDTHH:MM:SSZ) |
| date_to | Date updated to (YYYY-MM-DDTHH:MM:SSZ) | |
| Description | description | Description contains string |
| Volunteering Category | volunteering_category_id | Comma separated volunteering_category_ids |
| Constituent Id | constituent_id | Comma separated constituent_ids |
| Constituent Keyword | const_keyword | Comma separated Constituent keyword_ids |
| Updated At | updated_from | Date updated from (YYYY-MM-DDTHH:MM:SSZ) |
| updated_to | Date updated to (YYYY-MM-DDTHH:MM:SSZ) |
Note: Multiple terms may be combined using a semi-colon: "updated_from=2018-05-04;updated_to=2018-05-04"
Example - Search by Description, Sorted by Date:
URI: https://api.littlegreenlight.com/api/v1/volunteer_times/searchQuery:
q[]=description=Donor management&sort=date!&limit=5 |
Response:
|
Example - Search by Constituent Keyword ID and Updated Since:
URI: https://api.littlegreenlight.com/api/v1/volunteer_times/searchQuery:
q[]=const_keyword=12221;updated_from=2016-01-01&limit=5 |
Response:
|
GET /api/v1/volunteer_times - Fetch Volunteer Times for Account
Lists all the volunteer times for an account.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/volunteer_timesQuery:
limit=5 |
Response:
|
GET /api/v1/volunteer_times/{id} - Show Volunteer Time details
Show details for the volunteer time.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Volunteer Time Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/volunteer_times/3017Response:
|
PATCH /api/v1/volunteer_times/{id} - Update Volunteer Time
Update the volunteer time.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Volunteer Time Id | integer | true | path |
| body | Update Objects | UpdateBody | true | body |
UpdateBody
|
UpdateBody {
constituent_id
(
integer
, required
):
Constituent ID,
external_id
(
integer
, optional
):
External Volunteering ID,
volunteering_category_id
(
integer
, required
):
Volunteer Category Id,
volunteering_category_name
(
string
, optional
):
Volunteer Category Name,
description
(
string
, optional
):
Description,
hours
(
double
, optional
):
Hours,
date
(
date
, optional
):
Date,
end_date
(
date
, optional
):
End Date,
completed_hours
(
double
, optional
):
Completed Hours,
custom_fields
(
array
, optional
, CustomFieldAggregatedUpdate
):
VolunteerTime custom fields (Categories)
}
CustomFieldAggregatedUpdate {
id
(
integer
, optional
):
Custom Field Id,
name
(
string
, required
):
Name,
key
(
string
, optional
):
Key,
remove_previous_values
(
boolean
, optional
):
Remove previous field values,
values
(
array
, required
, CustomValueAggregatedUpdate
):
Values
}
CustomValueAggregatedUpdate {
id
(
integer
, required
):
Value Id,
name
(
string
, required
):
Name
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/volunteer_times/3017Body:
|
Response:
|
DELETE /api/v1/volunteer_times/{id} - Delete Volunteer Time
Delete the volunteer time.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Volunteer Time Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/volunteer_times/3017Response:
|
Web Address Management
GET /api/v1/constituents/{constituent_id}/web_addresses - Fetch Web Addresses
Lists all the web addresses.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| limit | Number of entries to return. Default: 25 | integer | query | |
| offset | Start at given entry. Default: 0 | integer | query |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/web_addressesResponse:
|
POST /api/v1/constituents/{constituent_id}/web_addresses - Create new Web Address
Add web address.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| constituent_id | Constituent Id | integer | true | path |
| body | Create Objects | CreateBody | true | body |
CreateBody
|
CreateBody {
url
(
string
, optional
):
Web Address,
web_address_type_id
(
integer
, optional
):
Web Address Type ID,
web_address_type_name
(
string
, optional
):
Web Address Type Name,
is_preferred
(
boolean
, optional
):
Make this the preferred email address
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/constituents/959480/web_addressesBody:
|
Response:
|
GET /api/v1/web_addresses/{id} - Show Web Address details
Show details for the web address.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Web Address Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/web_addresses/79Response:
|
PATCH /api/v1/web_addresses/{id} - Update Web Address
Update the web address.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Web Address Id | integer | true | path |
| body | Update Objects | UpdateBody | true | body |
UpdateBody
|
UpdateBody {
url
(
string
, optional
):
Web Address,
web_address_type_id
(
integer
, optional
):
Web Address Type ID,
web_address_type_name
(
string
, optional
):
Web Address Type Name,
is_preferred
(
boolean
, optional
):
Make this the preferred email address
}
|
| Code | Message | Response |
|---|---|---|
| 200 | Ok |
|
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 422 | Unprocessable Entity |
Example:
URI: https://api.littlegreenlight.com/api/v1/web_addresses/79Body:
|
Response:
|
DELETE /api/v1/web_addresses/{id} - Delete Web Address
Delete the web address.| Parameter Name | Description | Type | Required? | Parameter Type |
|---|---|---|---|---|
| id | Web Address Id | integer | true | path |
| Code | Message | Response |
|---|---|---|
| 200 | Ok | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Example:
URI: https://api.littlegreenlight.com/api/v1/web_addresses/79Response:
|