User

User Documentation

User [GET]

User [GET]

Request

Endpoint

GET /api/v2/user
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "b33bd71c-8917-4c05-acea-4e5a16d10377",
    "type": "users",
    "attributes": {
      "alma_mater": null,
      "anniversary_day": null,
      "anniversary_month": null,
      "anniversary_year": null,
      "avatar": "https://mpdx.org/images/avatar.png",
      "birthday_day": null,
      "birthday_month": null,
      "birthday_year": null,
      "created_at": "2021-11-23T14:37:44Z",
      "deceased": false,
      "employer": null,
      "first_name": "Kayla",
      "gender": null,
      "last_name": null,
      "legal_first_name": null,
      "marital_status": null,
      "middle_name": null,
      "occupation": null,
      "optout_enewsletter": false,
      "parent_contacts": [

      ],
      "preferences": {
        "hour_to_send_notifications": 12,
        "time_zone": "Auckland",
        "locale": "en",
        "default_account_list": null,
        "setup": "no default_account_list"
      },
      "suffix": null,
      "title": null,
      "updated_at": "2021-11-23T14:37:44Z",
      "updated_in_db_at": "2021-11-23T14:37:44Z"
    },
    "relationships": {
      "email_addresses": {
        "data": [
          {
            "id": "608a1ef2-198e-4573-ba27-1b415e1f675d",
            "type": "email_addresses"
          }
        ]
      },
      "facebook_accounts": {
        "data": [

        ]
      },
      "family_relationships": {
        "data": [

        ]
      },
      "linkedin_accounts": {
        "data": [

        ]
      },
      "phone_numbers": {
        "data": [

        ]
      },
      "twitter_accounts": {
        "data": [

        ]
      },
      "websites": {
        "data": [

        ]
      },
      "account_lists": {
        "data": [
          {
            "id": "fc04011c-e5ea-4804-aacc-ed275501d4e4",
            "type": "account_lists"
          }
        ]
      },
      "master_person": {
        "data": {
          "id": "60ef6ea9-05ec-4113-b1a7-5f17737ab833",
          "created_at": "2021-11-24T03:37:44+13:00",
          "updated_at": "2021-11-24T03:37:44+13:00"
        }
      }
    }
  }
}

Fields

Attributes

alma_mater

Type string

Description The college a person graduated from

anniversary_day

Type number

Description Anniversary Day

anniversary_month

Type number

Description Anniversary Month

anniversary_year

Type number

Description Anniversary Year

avatar

Type string

Description Avatar

birthday_day

Type number

Description Birthday Day

birthday_month

Type number

Description Birthday Month

birthday_year

Type number

Description Birthday Year

created_at

Type string

Description Created At

deceased

Type boolean

Description Deceased

employer

Type string

Description Employer

first_name

Type string

Description First Name

gender

Type string

Description Gender

last_name

Type string

Description Last Name

legal_first_name

Type string

Description Legal First Name

marital_status

Type string

Description Marital Status

middle_name

Type string

Description Middle Name

occupation

Type string

Description Occupation

optout_enewsletter

Type boolean

Description Optout of enewsletter

parent_contacts

Type ["Contact"]

Description Parent contacts of this user

preferences

Type object

Description User preferences with object with the following format { "contacts_filter": "string - the current state of the contacts filter", "contacts_view_options": "string - the current state of the contacts view options", "default_account_list": "id string - the default account list to display on load", "locale": "string - locale", "setup": "boolean - indicating if the user is still in the setup process", "tab_orders": "string - the order of tabs on the contact show page", "tasks_filter": "string - the current state of the task filter", "time_zone": "string - the timezone the user is currently in", "hour_to_send_notifications": "integer - hour of day to send notifications (between 0 to 23 or nil if immediately)" }

suffix

Type string

Description Suffix

title

Type string

Description Title

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_lists.data

Type [AccountList]

Description account lists this user has access to

email_addresses.data

Type [EmailAddress]

Description An array of email addresses belonging to this user

facebook_accounts.data

Type [FacebookAccount]

Description An array of facebook accounts belonging to this user

family_relationships.data

Type [FamilyRelationship]

Description An array of family relationships belonging to this user

linkedin_accounts.data

Type [LinkedinAccount]

Description An array of linkedin accounts belonging to this user

master_person.data.id

Type ID string

Description The id of the Master Person that this user belongs to

phone_numbers.data

Type [PhoneNumber]

Description An array of phone numbers belonging to this user

twitter_accounts.data

Type [TwitterAccount]

Description An array of twitter accounts belonging to this user

websites.data

Type [Website]

Description An array of websites belonging to this user

User [PUT]

User [PUT]

Request

Endpoint

PUT /api/v2/user
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "users",
    "attributes": {
      "first_name": "Daphne",
      "updated_in_db_at": "2021-11-23 14:37:44 UTC"
    }
  }
}

Parameters

Attributes

alma_mater

Type string

Description The college a person graduated from

Required No

anniversary_day

Type number

Description Anniversary Day

Required No

anniversary_month

Type number

Description Anniversary Month

Required No

anniversary_year

Type number

Description Anniversary Year

Required No

avatar

Type string

Description Avatar

Required No

birthday_day

Type number

Description Birthday Day

Required No

birthday_month

Type number

Description Birthday Month

Required No

birthday_year

Type number

Description Birthday Year

Required No

created_at

Type string

Description Created At

Required No

deceased

Type boolean

Description Deceased

Required No

employer

Type string

Description Employer

Required No

first_name

Type string

Description First Name

Required No

gender

Type string

Description Gender

Required No

last_name

Type string

Description Last Name

Required No

legal_first_name

Type string

Description Legal First Name

Required No

marital_status

Type string

Description Marital Status

Required No

middle_name

Type string

Description Middle Name

Required No

occupation

Type string

Description Occupation

Required No

optout_enewsletter

Type boolean

Description Optout of enewsletter

Required No

overwrite

Type boolean

Description Only used for updating a record where you want to ignore the server's ' 'updated_in_db_at value and force overwrite the values for the record. ' 'Must be true to work.

Required No

parent_contacts

Type ["Contact"]

Description Parent contacts of this user

Required No

preferences

Type object

Description User preferences with object with the following format { "contacts_filter": "string - the current state of the contacts filter", "contacts_view_options": "string - the current state of the contacts view options", "default_account_list": "id string - the default account list to display on load", "locale": "string - locale", "setup": "boolean - indicating if the user is still in the setup process", "tab_orders": "string - the order of tabs on the contact show page", "tasks_filter": "string - the current state of the task filter", "time_zone": "string - the timezone the user is currently in", "hour_to_send_notifications": "integer - hour of day to send notifications (between 0 to 23 or nil if immediately)" }

Required No

suffix

Type string

Description Suffix

Required No

title

Type string

Description Title

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

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.

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "cbb831b9-85c9-428d-aacb-3257a3f416a1",
    "type": "users",
    "attributes": {
      "alma_mater": null,
      "anniversary_day": null,
      "anniversary_month": null,
      "anniversary_year": null,
      "avatar": "https://mpdx.org/images/avatar.png",
      "birthday_day": null,
      "birthday_month": null,
      "birthday_year": null,
      "created_at": "2021-11-23T14:37:44Z",
      "deceased": false,
      "employer": null,
      "first_name": "Daphne",
      "gender": null,
      "last_name": null,
      "legal_first_name": null,
      "marital_status": null,
      "middle_name": null,
      "occupation": null,
      "optout_enewsletter": false,
      "parent_contacts": [

      ],
      "preferences": {
        "hour_to_send_notifications": 12,
        "time_zone": "Auckland",
        "locale": "en",
        "default_account_list": null,
        "setup": "no default_account_list"
      },
      "suffix": null,
      "title": null,
      "updated_at": "2021-11-23T14:37:44Z",
      "updated_in_db_at": "2021-11-23T14:37:44Z"
    },
    "relationships": {
      "email_addresses": {
        "data": [
          {
            "id": "847b5f82-727c-419f-ae08-6d34d2fe4324",
            "type": "email_addresses"
          }
        ]
      },
      "facebook_accounts": {
        "data": [

        ]
      },
      "family_relationships": {
        "data": [

        ]
      },
      "linkedin_accounts": {
        "data": [

        ]
      },
      "phone_numbers": {
        "data": [

        ]
      },
      "twitter_accounts": {
        "data": [

        ]
      },
      "websites": {
        "data": [

        ]
      },
      "account_lists": {
        "data": [
          {
            "id": "9b048df9-f8bf-4527-a655-255a9a8c215b",
            "type": "account_lists"
          }
        ]
      },
      "master_person": {
        "data": {
          "id": "d89de13f-eb00-4ba0-9dff-f10e014ac03a",
          "created_at": "2021-11-24T03:37:44+13:00",
          "updated_at": "2021-11-24T03:37:44+13:00"
        }
      }
    }
  }
}

Fields

Attributes

alma_mater

Type string

Description The college a person graduated from

anniversary_day

Type number

Description Anniversary Day

anniversary_month

Type number

Description Anniversary Month

anniversary_year

Type number

Description Anniversary Year

avatar

Type string

Description Avatar

birthday_day

Type number

Description Birthday Day

birthday_month

Type number

Description Birthday Month

birthday_year

Type number

Description Birthday Year

created_at

Type string

Description Created At

deceased

Type boolean

Description Deceased

employer

Type string

Description Employer

first_name

Type string

Description First Name

gender

Type string

Description Gender

last_name

Type string

Description Last Name

legal_first_name

Type string

Description Legal First Name

marital_status

Type string

Description Marital Status

middle_name

Type string

Description Middle Name

occupation

Type string

Description Occupation

optout_enewsletter

Type boolean

Description Optout of enewsletter

parent_contacts

Type ["Contact"]

Description Parent contacts of this user

preferences

Type object

Description User preferences with object with the following format { "contacts_filter": "string - the current state of the contacts filter", "contacts_view_options": "string - the current state of the contacts view options", "default_account_list": "id string - the default account list to display on load", "locale": "string - locale", "setup": "boolean - indicating if the user is still in the setup process", "tab_orders": "string - the order of tabs on the contact show page", "tasks_filter": "string - the current state of the task filter", "time_zone": "string - the timezone the user is currently in", "hour_to_send_notifications": "integer - hour of day to send notifications (between 0 to 23 or nil if immediately)" }

suffix

Type string

Description Suffix

title

Type string

Description Title

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_lists.data

Type [AccountList]

Description account lists this user has access to

email_addresses.data

Type [EmailAddress]

Description An array of email addresses belonging to this user

facebook_accounts.data

Type [FacebookAccount]

Description An array of facebook accounts belonging to this user

family_relationships.data

Type [FamilyRelationship]

Description An array of family relationships belonging to this user

linkedin_accounts.data

Type [LinkedinAccount]

Description An array of linkedin accounts belonging to this user

master_person.data.id

Type ID string

Description The id of the Master Person that this user belongs to

phone_numbers.data

Type [PhoneNumber]

Description An array of phone numbers belonging to this user

twitter_accounts.data

Type [TwitterAccount]

Description An array of twitter accounts belonging to this user

websites.data

Type [Website]

Description An array of websites belonging to this user