Public Constituent Information

The Constituent Information API is a RESTful API.

The service provides basic information about a constituent.

A constituent is any person or organization that has made a commitment to provide resources (money, time or influence) for the purpose of supporting Compassion International's ministry.

Sample Requests
Request Parameters
Response Parameters
Sample Successful Response
Sample Unsuccessful Response
Error Response Codes

Sample Request

The actual request requires soft-authentication.
This is an example only.

https://api2.compassion.com/us/1/constituent/information? ConstituentId= [string]& EmailAddress= [string]& ClientReferenceId= [string]& api_key= [string]

Request Parameters

Name Description Required Data Type Constraints
ConstituentId Constituent Id is assigned by Compassion International to any person or organization that has made a commitment to provide resources (money, time or influence) for the purpose of supporting Compassion's ministry. Constituent Id is also known as Sponsor Id or Supporter Id. Yes Numeric Max 10
EmailAddress Constituent’s preferred email address on file at Compassion International. Service client should pass in URL encoded value if the email address contains special characters. Yes String Max 60
ClientReferenceId Uniquely represents the transaction in the client's system. Optional String Max 100
api_key Your Mashery supplied key for an application running Compassion International services. Yes String  

Response Parameters

Name Description
ConstituentId Constituent Id is assigned by Compassion International to any person or organization that has made a commitment to provide resources (money, time or influence) for the purpose of supporting Compassion's ministry. Constituent Id is also known as Sponsor Id or Supporter Id
EmailAddress Constituent’s preferred email address on file at Compassion International.
ConstituentName Full name of the constituent.
ISOCountryCode Two-character code assigned to a country by the International Organization for Standardization (ISO) as defined in the ISO 3166-1 standard.
ParticipationSalutation Salutation used by the CDSP child or LDP student to communicate with the constituent.

Sample Successful Response

Sample Successful Response

Sample Unsuccessful Response

The service operation will provide the following response when there are missing required parameters.
Exception Returned: (ResponseCode = "1", HTTP Status Code ="404")

Sample Unsuccessful Response

Error Response Codes

For ResponseCode = 1, the table below indicates the HTTP error response and HTTP Error message.

HTTP Error Response HTTP Error Message
HTTP 400 Service Parameter Failure
HTTP 401 Not Authenticated / Authorized for Service Data
HTTP 403 Not Authorized
HTTP 403 Account Inactive
HTTP 403 Over Queries Per Second Limit
HTTP 403 Over Rate Limit
HTTP 403 Unknown Referrer
HTTP 404 Requested Resource Not Found
HTTP 408 Request Timeout
HTTP 414 Request URI Too Long
HTTP 500 Internal Server Error
HTTP 502 Bad Gateway
HTTP 503 API Maintenance / Service Unavailable
HTTP 504 Gateway Timeout

Docs Navigation