Contacts
Contacts Documentation
Contact [LIST]
Contact [LIST]
Request
Endpoint
GET /api/v2/organizations/contacts
Content-Type: application/vnd.api+json
Body
Parameters
Sorts
name
Type Unknown
Description sort by contact name
Required No
Filters
organization_id
Type ID string
Description filter where contact's account list has a designation account belonging to an organization; Accepts IDs separated by comma
Required No
status
Type string
Description Filter by Status; Accepts multiple parameters, with values 'active', 'hidden', 'null', 'Never Contacted', 'Ask in Future', 'Cultivate Relationship', 'Contact for Appointment', 'Appointment Scheduled', 'Call for Decision', 'Partner - Financial', 'Partner - Special', 'Partner - Pray', 'Not Interested', 'Unresponsive', 'Never Ask', 'Research Abandoned', and 'Expired Referral'
Required No
wildcard_search
Type string
Description filter where contact matches the wildcard_search on a variety of fields
Required No
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
Body
{
"data": [
{
"id": "e925ceae-a6f4-4f57-a630-e238c7ec1e5f",
"type": "contacts",
"attributes": {
"allow_deletion": true,
"created_at": "2021-11-23T14:37:41Z",
"name": "Paucek, Lean",
"square_avatar": "https://mpdx.org/images/avatar.png",
"updated_at": "2021-11-23T14:37:41Z",
"updated_in_db_at": "2021-11-23T14:37:41Z"
},
"relationships": {
"account_list": {
"data": {
"id": "404ab22d-6f13-40d2-b66c-37b44915b42e",
"type": "account_lists"
}
},
"people": {
"data": [
]
},
"addresses": {
"data": [
]
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Fields
data
Type
[Contact]
Description An array of contacts
Contact [GET]
Contact [GET]
Request
Endpoint
GET /api/v2/organizations/contacts/642159d5-1a49-4ff8-ae99-dcd8ab4932f7
Content-Type: application/vnd.api+json
Body
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
Body
{
"data": {
"id": "642159d5-1a49-4ff8-ae99-dcd8ab4932f7",
"type": "contacts",
"attributes": {
"allow_deletion": true,
"created_at": "2021-11-23T14:37:41Z",
"name": "Volkman, Lettie",
"square_avatar": "https://mpdx.org/images/avatar.png",
"updated_at": "2021-11-23T14:37:41Z",
"updated_in_db_at": "2021-11-23T14:37:41Z"
},
"relationships": {
"account_list": {
"data": {
"id": "05b04e6d-9b99-4e88-bed7-07d2dcba0ab3",
"type": "account_lists"
}
},
"people": {
"data": [
]
},
"addresses": {
"data": [
]
}
}
}
}
Fields
Attributes
allow_deletion
Type
boolean
Description can the contact be deleted or only anonymized
created_at
Type
date
Description The timestamp of when this resource was created
name
Type
string
Description name of the contact
square_avatar
Type
string
Description A url for the Contact's avatar - but in a square format
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Relationships
account_list.data
Type
AccountList
Description the account_list that this contact belongs to
addresses.data
Type
["Address"]
Description collection of addresses
people.data
Type
["Person"]
Description collection of people
Contact [DELETE]
Contact [DELETE]
Request
Endpoint
DELETE /api/v2/organizations/contacts/c7f0cda0-dd79-41b9-87fd-b6c4799dd561
Content-Type: application/vnd.api+json
Body
Response
Headers
204 No Content
Body
Last updated