Home

Download this help site
(PDF 80MB)

Download

ContactFields API V1 call

Icon

Wild Apricot does not provide technical support for its API. If you encounter difficulties using it, add a post describing the issue to our Designers and Developers forum. Wild Apricot staff or other users may be able to suggest a solution.

You can use the ContactFields API call to retrieve a detailed list of the common and membership fields in your Wild Apricot database, and well as additional system fields. Any of the fields returned by the ContactFields API call can be used to filter the results of the Contacts API V1 call.

Syntax

Example:

Parameters

The following parameters are used within the ContactFields API call:

Variable

Description

{version}

The version number of the API. To retrieve a list of API versions, use the base API call.

{accountID}

The account identifier that appears on the Account and billing screen and is returned by the Accounts API V1 call.

{APIkey}

String of characters used to authenticate your account and prevent others from accessing your data. You can get your API key by clicking the API key link from the Settings screen. The API key can be passed as a URL parameter or as a HTTP header field.

Response fields

For each common and membership field in your Wild Apricot database, the ContactFields API call retrieves the following information.

Field

Description

FieldName

The name of the field.

Type

The field type. Possible values and the corresponding field types as they appear in Wild Apricot are:
String – text, multiline text
Number – various system fields
Boolean – rules and terms, various system fields
DateTime – date
Choice – radio buttons, dropdown, radio buttons with extra charge
MultipleChoice – multiple choice, multiple choice with extra charge

IsSystem

Whether the field is a system field. Possible values are true or false.

Access

The access setting for the field. Possible values are AdminOnly, Member, and Public.

FieldInstructions

Any field instructions that have been entered for the field.

Description

The description that appears for system fields.

AllowedValues

For multi-option fields – those with a field Type of Choice (radio buttons, dropdown, extra charges radio buttons) or MultipleChoice (multiple choice, extra charge multiple choice) – the ID and label of each individual option is returned. You can use either the option ID or option label within your filter criteria when retrieving contact records using the Contacts API V1 call.


Information is also retrieved for the following system fields:

Field

Description

Type

Possible values

Archived

Indicates whether the contact record is archived.

Boolean

true, false

Access to profile by others

Indicates whether the Show profile option is enabled in this member's privacy settings

Boolean

true, false

Balance

The current balance outstanding for this contact. If there is a balance due, then the value of this field will be negative.

Number

Any integer (positive or negative)

Creation date

The date and time the contact record was created.

DateTime

Any date using the format dd/mm/yyyy hh:mm:ss AM/PM

Donor

Indicates whether the contact has made at least one donation.

Boolean

true, false

Email delivery disabled

Indicates whether email delivery is disabled for this contact, either because no email address was specified or the delivery of emails was disabled.

Boolean

true, false

Event announcements

Indicates whether event announcements are enabled within the contact's email preferences.

Boolean

true, false

Event attendee

Indicates whether the contact has registered for at least one event.

Boolean

true, false

Group participation

The names of the member groups to which the member belongs. Multiple groups are separated by commas within the ContactFields API results. When using this field to filter results from the Contacts API V1 call, you can reference only one group at a time, though you can reference multiple groups separately then join the multiple criteria using logical operators (AND, OR).

String

Group name(s)

Last login date

The date and time the contact last logged in to their account. If the contact has never logged in, then the value of this field will be null.

DateTime

Any date using the format dd/mm/yyyy hh:mm:ss AM/PM

Level last changed

The date and time the contact's membership level was last changed. If the level has never been changed, then the value of this field will be null.

DateTime

Any date using the format dd/mm/yyyy hh:mm:ss AM/PM

Member

Indicates whether the contact is a member.

Boolean

true, false

Member emails and newsletters

Indicates whether manually sent emails are enabled within the contact's email preferences.

Boolean

true, false

Member ID

The ID of the contact as displayed on their contact record.

Number

Any integer

Member role

Indicates whether the contact is an individual member, a bundle member, or a bundle administrator.

String

BundleAdministrator, BundleMember, Individual

Member since

The date and time that the contact became a member.

DateTime

Any date using the format dd/mm/yyyy hh:mm:ss AM/PM

Membership level ID

The identifier of the membership level assigned to the contact (if any).

Number

Any integer

Membership status

The status of the contact's membership.

Choice

Active, Lapsed, PendingNew, PendingRenewal, PendingUpgrade

Notes

Any notes added to the contact's record.

String

Any alphanumeric characters

Profile last updated

The date and time that common fields, membership fields, or member group participation were last updated for the contact.

DateTime

Any date using the format dd/mm/yyyy hh:mm:ss AM/PM

Receiving emails disabled

Indicates whether the delivery of all emails was disabled from the contact's email preferences.

Boolean

true, false

Registered for specific event

Indicates whether the contact has registered for the specified event. The event can be specified as part of the filter criteria when filtering the results of the Contacts API V1 call.

 

 

Renewal due

The date and time of the member's next renewal date.

DateTime

Any date using the format dd/mm/yyyy hh:mm:ss AM/PM

Renewal date last changed

The date and time the member's renewal date was last changed. If the date has never been changed, then the value of this field will be null.

DateTime

Any date using the format dd/mm/yyyy hh:mm:ss AM/PM

Suspended member

Indicates whether the contact is a suspended member.

Boolean

true, false

Total donated

The total value of all donations made by this contact.

Number

Any integer

Sample JSON response

Sample XML response

  • No labels
 
Wild Apricot Inc. 144 Front Street West Suite 725, Toronto, Ontario, Canada M5J 2L7