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": "a7506cb9-172a-4e64-a78a-3fe57063a173",
      "type": "contacts",
      "attributes": {
        "allow_deletion": true,
        "created_at": "2022-01-12T17:17:59Z",
        "name": "Nikolaus, Hal",
        "square_avatar": "https://mpdx.org/images/avatar.png",
        "updated_at": "2022-01-12T17:17:59Z",
        "updated_in_db_at": "2022-01-12T17:17:59Z"
      },
      "relationships": {
        "account_list": {
          "data": {
            "id": "1a061060-da47-4ca9-800f-2339bffd3831",
            "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/f2111bfc-7b2a-417f-9507-179aba32e15a
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "f2111bfc-7b2a-417f-9507-179aba32e15a",
    "type": "contacts",
    "attributes": {
      "allow_deletion": true,
      "created_at": "2022-01-12T17:17:59Z",
      "name": "Bogisich, Parker",
      "square_avatar": "https://mpdx.org/images/avatar.png",
      "updated_at": "2022-01-12T17:17:59Z",
      "updated_in_db_at": "2022-01-12T17:17:59Z"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "44a29cbf-b842-4676-bc3c-09abe3586849",
          "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/f280bb30-8bdb-451d-b79f-2042e4cf87b6
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body