This method returns a single constituent record.
| Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
|---|---|---|---|
| CRConsAPI | SRConsAPI | POST | Yes. |
If a field is not included in the response, it is either not enabled for the site or it is invisible to the caller. If the field is included but has no value (xsi:nil="true" in an XML response or null in a JSON response), then the field is visible and has a null value for the retrieved record. If a composite element (one that can contain nested elements), such as "name" or "email" in the example above, is nil then all of its contained fields are either disabled or have nil values for this record.
See topic Common Parameters.
Optional. The constituent ID (Luminate Online ID) that uniquely identifies the constituent. This value is automatically assigned when a new constituent record is created. It can be used to uniquely identify a constituent record to read or update it. Only available when called using an administrator account.
Type xsd:string.
Optional. Specifies a comma-separated list of names of fields to retrieve. If not specified, then all fields in use and visible to the caller are returned. Use "dot" notation to refer to nested elements of the XML schema. For example, use "name.first" to request the "first" element of the "name" element (the user's first name).
Type xsd:string.
Optional. The member ID (Client ID) that uniquely identifies the constituent.
Type xsd:string.
Optional. The primary email address that uniquely identifies the constituent.
Type xsd:string.
See topic Common Parameters.
Optional. The constituent ID (Luminate Online ID) that uniquely identifies the constituent. This value is automatically assigned when a new constituent record is created. It can be used to uniquely identify a constituent record to read or update it. Only available when called using an administrator account.
Type xsd:string.
Optional. Specifies a comma-separated list of names of fields to retrieve. If not specified, then all fields in use and visible to the caller are returned. Use "dot" notation to refer to nested elements of the XML schema. For example, use "name.first" to request the "first" element of the "name" element (the user's first name).
Type xsd:string.
Optional. The member ID (Client ID) that uniquely identifies the constituent.
Type xsd:string.
Optional. The primary email address that uniquely identifies the constituent.
Type xsd:string.
See topic HTTP Status Codes.
XML response
<?xml version="1.0" encoding="UTF-8"?>
<getConsResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<cons_id>1000121</cons_id>
<member_id>Member ID</member_id>
<user_name>Username</user_name>
<name>
<first>First</first>
<last>Last</last>
</name>
<email>
<primary_address>email@address.net</primary_address>
</email>
<primary_address>
<street1>Street</street1>
<city>City</city>
<state>State</state>
<zip>Zip</zip>
</primary_address>
</getConsResponse>
JSON response
{"getConsResponse":{"user_name":"Username","primary_address":{"zip":"Zip","street1":"Street","state":"State","city":"City"},"email":{"primary_address":"email@address.net"},"name":{"last":"Last","first":"First"},"cons_id":"1000121","member_id":"Member ID"}}