close anchor

Contacts

To get information on contacts:

GET /contacts

Parameters

Param Type Description Optional
id string The UUID of individual contact entries to be delivered by this endpoint, provided in a comma-delimited list.

In order to prevent entries from being delivered by this endpoint, include a '!' prefix before the list of those to exclude.
editor string The UUID of an individual user by whom to filter entries based on their editorial purview (i.e., the privilege granted to editor-level users to edit or delete entries), as defined for the project.

If provided, this endpoint will deliver contact entries including: those input by this user, those in group(s) linked to user group(s) in which this user exists (or in group(s) from which this user's not been excluded, depending on the editorial purview defined for the project), those identified with content entries for which this user is granted privilege, and those identified with the user directly (i.e., being linked to their profile via the /user/contacts endpoint).
user_input_by string The UUID of the primary user identified with a contact, being the user who initially entered it, if known. Include an empty value to query for contacts identified with no primary user.
user_index_of string The UUID of a user to be identified with contacts, being linked to their profile via the /user/contacts endpoint.
group string Indicate, by providing a comma-delimited list, the UUID of contact group(s) by which to filter entries. Include a '+' prefix before this list of groups if an entry is to be identified with every group declared (the default behavior of this endpoint is to provide entries in any of the group(s) included), and prefix an individual group therein with '!' to exclude contacts linked to it.
text string Include text by which to filter entries. Input will be parsed for up to ten keywords and treated as a filter, in that only entries with keyword(s) present in the fields below will be included.
fields string Indicate, by providing a comma-delimited list, the field(s) in which to expect text keyword(s) be present. If a field includes localized text, only values in the endpoint transaction locale will be queried. If empty or not provided, each of these valid fields will be included: email, name.first, name.last, organization, url.
order string Indicate, by providing a comma-delimited list, the field(s) by which to order entries found. Include a '-' prefix if descending order is preferred in a given field ('+' is inferred by default). If empty or not provided, these valid fields will not be explicitly included: date_time.edit, date_time.init, email, id, name.first, name.last, ordinal.user, organization.

If ordinal.user is present in the field(s) to order by and the user_index_of parameter was included, too, this endpoint will deliver entries in the preferred order indicated by that user, if defined.
page integer Identify the page on which to begin delivering entries. If not provided, the default value of 1 will be inferred.
limit integer Indicate a total of up to 100 entries to be delivered. If not provided, the default value of 10 will be inferred.
data string Indicate, by providing a comma-delimited list, the data field(s) to be delivered by this endpoint. If empty or not provided, this endpoint will include by default each of the data field(s) identified with the contact object.

The data object provided by this endpoint includes both a total (integer) of entries found, and an index (array) of contact(s).

To post a contact:

POST /contacts

Parameters

Provide the input field(s) below as a JSON-encoded data object:

Param Type Description Optional
name object The personal first and last name of the contact.
organization string The institutional name provided for the contact.
email string The e-mail to be identified with the contact.
url string The primary URL to be identified with the contact.

The data object provided by this endpoint is the contact inserted to the project.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_email The email provided is not valid.
invalid_url The url provided is empty or badly formed.

If an error is not described on this page, the platform-wide error table provides further information.

To edit or update a contact:

PUT /contacts

In order to edit a contact, log in the user identified with the contact (or a user with editor-level privileges).

Parameters

Provide the input field(s) below as a JSON-encoded data object:

Param Type Description Optional
id string The UUID of the contact to be updated.
name object The personal first and last name of the contact.
organization string The institutional name provided for the contact.
email string The e-mail to be identified with the contact.
url string The primary URL to be identified with the contact.
locations array The location(s) to identify with this contact, being a one-dimensional array in which each value is the UUID of an individual location, provided in the order in which each is to be delivered for this contact.
phones array The phone number(s) to identify with this contact, being a one-dimensional array in which each value is the UUID of an individual phone number entity, provided in the order in which each is to be delivered for this contact.
groups array The contact group(s) in which this contact is to exist, being a one-dimensional array in which each value is the UUID of an individual contact group. In order to post a contact to a group, log in a user with owner-level privileges or an editor in a user group linked to the contact group in question.

The contact will no longer be identified with groups not included in this transaction. In order to post a contact to a group individually (not deleting it from other groups in which it'd previously been included), use the /contact/groups endpoint instead.

The data object provided by this endpoint is the updated contact.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_email The email provided is not valid.
invalid_url The url provided is empty or badly formed.

If an error is not described on this page, the platform-wide error table provides further information.

To delete a contact:

DELETE /contacts

This endpoint provides for deleting a contact.

In order to delete a contact, log in the user identified with the contact (or a user with editor-level privileges).

Parameters

Param Type Description
id string The UUID of the contact to be deleted.

The data object provided by this endpoint is the deleted contact.

Register for an Invitation
Thank you!
We'll be in touch.
First Name*
Last Name*
(optional) Business Name
Role*
Email*