Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Only available in v0.2.x

The following endpoint is currently unavailable. It will be released in version 1.2.x with the mobile applications.

Resource URL

Returns a contact identified by contact id.

GET /contacts/:contact_id

Handling the response

Below is a table of available response fields and objects that are returned within the response object of the returned object. The optional fields and objects can be requested in the _fields parameter; see included examples. Underlined values are default.

If you can't find the field you are after, you are probably thinking of an affiliation field. Please see the affiliation endpoints.

idunsigned int A unique id assigned to the contact
firstnamestring 
surnamestring 
titlestring 
middlenamestring 
standingstring 
date_createdunix timestamp 
date_modifiedunix_timestamp 
commentsstring 
statusunsigned int 
status(<args>)object 
default_affiliation_idunsigned int 

Fields that can be object indicate the field can be requested as a resource. For example.

GET /contacts/1.json?_fields=status

would return the status id. Where as,

GET /milestones/1.json?_fields=status()

would return the status object, including any optional fields or objects within the parenthesis.

  • No labels