Responses

• 200 application/json

  OK

  Hide response attribute Show response attribute object

  • people array[object]
    Hide people attributes Show people attributes object

    • unique_id integer
    • url string
    • title string
    • firstname string
    • middlename string
    • lastname string
    • organisationcontact string

      Values are Y or N.

    • gender string

      Values are ORGANISATION, Male, or Female.

    • phone array[object]
      Hide phone attributes Show phone attributes object

      • for string

        Wether this is for the organisation/household or the individual

        Values are PERSONAL or ORGANISATION.

      • id integer

        The ID of this phone number record (when 'for' is PERSONAL)

      • type string

        The word used to describe this phone number

      • value string

        Phone number as entered by the user

    • cell array[object]
      Hide cell attributes Show cell attributes object

      • id integer

        The ID of this cell phone record

      • type string

        The word used to describe this cell phone number

      • value string

        Phone number as entered by the user

    • email array[object]
      Hide email attributes Show email attributes object

      • id integer

        The ID of this email address record

      • type string

        The word used to describe this email address

      • value string

        Email address as entered by the user

      • active integer

        Whether this email address is active or not

        Values are 0 or 1.

    • person_image string

      The string contains an image that is base64 encoded image

    • address object

      Additional properties are allowed.

      Hide address attributes Show address attributes object

      • houseid integer
      • organisation string
      • householdname string
      • housenamenum string

        For UK addresses to separate the street address from the house name/number

      • addressline1 string
      • addressline2 string
      • area string
      • city string
      • postcode string
      • fax string
      • country string
      • formatted string
      • phone string
      • phonelabel string
      • visible integer

        Whether the address is visible or private

    • date_time_changed_utc string

      Format yyyy-mm-ddThh:nn:ss

    • notes object

      Additional properties are allowed.

      Hide notes attributes Show notes attributes object

      • view string

        Whether the user retrieving this item has permission to view notes written about them - subject to permissions on each note

        Values are Y or N.

      • create string

        Whether the user retrieving this item has permission to create notes

        Values are Y or N.

    • person_custom_fields object

      Additional properties are allowed.

      Hide person_custom_fields attribute Show person_custom_fields attribute object

      • person_customised_tab_name object

        Each object represents a tab. The users can created their own tabs. The tab name "PERSONAL" is always provided which shows the fields on the front of the person profile page.

        Additional properties are allowed.

        Hide person_customised_tab_name attribute Show person_customised_tab_name attribute object

        • person_custom_field object

          Each object represents a custom field. This is repeated for every custom field. The output is common except for the Date of Birth field and the field type P

          Additional properties are allowed.

          Hide person_custom_field attributes Show person_custom_field attributes object

          • type string

            D: Date. Raw is format YYYY-MM-DD. Value e.g. 1 Jul 2022, the format is set by the administration-system-date settings. For Date of Birth, additional field "age" is the text of the age e.g. 45 years. N: integer Y: Yes/No. Raw is 0 or 1. value is Yes or No L: Lookup. Raw is an integer to identify the lookup id. Value is the decode of the lookup ID ML. Multilookup. Raw and Value show the decode of the list of selected items H: URL to a website P: Person Lookup. Raw is the ID of the user ID this person is connected to. The value field is an object: "connectee": [], "connector": { "name": "John Miller", "unique_id": "67284" }

            looking at John Millers record shows "connectee": [ { "name": "Dave Trainer", "unique_id": "779" } ], "connector": "" I: Auto incrementing number G: Long Text. Up to 2k chars. New lines separated by carriage return.

            Values are D, N, Y, L, ML, P, H, or I.

          • raw string

            The unprocessed data value For a "P" data type, this is the unique_id of the "connector". If no connector this is blank.

          • value string
    • household_custom_fields object

      Additional properties are allowed.

      Hide household_custom_fields attribute Show household_custom_fields attribute object

      • HOUSEHOLD object

        Only 1 tab is available for households. This is fixed name regardless of whether using household or organisation view.

        Additional properties are allowed.

        Hide HOUSEHOLD attribute Show HOUSEHOLD attribute object

        • household_custom_field object

          Each object represents a custom field. This is repeated for every custom field. The field types and output is the same as for person_custom_fields.

          Additional properties are allowed.

    • connected array[object]
      Hide connected attributes Show connected attributes object

      • unique_id integer
      • name string
      • type string

        Value is Unknown.

      • gender string

        Values are Male, Female, or ORGANISATION.

      • organisationContact string

        Values are N or Y.

      • person_image string

        A Base64 encode of the image of the person

    • alternate array[object]

      A list of contacts that this record is connected to as an alternate household.

      Hide alternate attributes Show alternate attributes object

      • id integer
      • unique_id integer
      • text string
    • alternateAddresses array[object]

      A list of all the alternate addresses for this contact

      Hide alternateAddresses attributes Show alternateAddresses attributes object

      • id integer

        The id of this specific alternate address record

      • address_type string
      • houseid integer
      • text string

        A single string showing the full address (excluding country)

      • formatted string

        All address lines with each line separated, includes country

      • organisation string

        When the site is in organisation view - this contains the organisation name

      • householdname string

        When the site is not in organisation view - this contains the household name

      • addressline1 string
      • addressline2 string
      • addressline3 string

        When address line 3 and 4 are enabled, this holds these additional address lines

      • addressline4 string

        When address line 3 and 4 are enabled, this holds these additional address lines

      • area string
      • city string
      • postcode string
      • fax string
      • country string
      • phone string
      • phonelabel string
    • canEdit integer

      Whether the current user is allowed to edit this contact

    • last_updated_datetime_utc string

      The date/time in UTC of the last updated date/time of the contact

    • lastUpdatedDatetimeUtcShowLocal string

      The local datetime (as per the administration-system-date settings), shown in the local format