Back to endpoints

Get a person by externalId in an organization

GET api/V3/{language}/org/{orgIdentifier}/persons/external/{id}

This endpoint searches the person by an external membership, and the person must be part of the searching organization.

Request Information

URI Parameters

language (string)

Language in which the localizable values should be returned. Part of base url. Value is either 'fr' or 'en'

orgIdentifier (string)

Amilia-specific organization identifier. This identifier can be either the organization number, such as 8008, or the organization URL identifier. You can find that by looking at the URL of your Amilia store. It may look like lower-case words separated by a dash, such as forest-explorers. Note that in v2 and v1 we call that the 'rewrite URL'.

id (string)

Id of the item before the /{id} in the url


Body Parameters


Response Information

Resource Description

OrganizationId (integer)

Id of the organization. This one cannot be substituted for rewriteUrl, contrary to the organization id in the query parameters

AccountId (integer)

Id of the account

AccountOwnerId (integer)

Id of the account owner

AccountOwnerFirstName (string)

First name of the account owner

AccountOwnerLastName (string)

Last name of the account owner

AccountOwnerFullName (string)

First and last name of the account owner with a space in between

AccountOwnerEmail (string)

Email address of the account owner

AccountOwnerTelephoneMobile (string)
IsArchived (boolean)

True if resource is archived

Contacts ()

Object containing the persons who are listed as contacts and their details

Skills ()

Object containing the skills and their details

Registrations ()

Object containing the registrations and their details

MedicalInformation (MedicalInformationApiModelV3)

Object containing the medical information (allergies, sicknesses, reactions, medication) for a person

JoinDate (date)

Date when the person joined

PictureUrl (string)

Url of the resource picture

Memberships ()
ExternalId (string)
Friend (string)
PickupPassword (string)
Id (integer)

Resource id

FirstName (string)

First name of the person

LastName (string)

Last name of the person

FullName (string)

First and last name with a space in between

Gender (Gender)

Object containing the gender values NotSpecified, Male, Female and PreferNotToSay

DateOfBirth (date)

Format is 9999-12-31

Email (string)

Email address

Address (GeoAddressApiModelV3)

Object containing the address (door number, street name, city, state/province, country, zip/postal code, latitude and longitude)

Telephone (string)

Telephone number

TelephoneMobile (string)

Mobile telephone number

TelephoneWork (string)

Work telephone number

TelephoneWorkExtension (string)

Work telephone number extension

IsChild (boolean)

True when the person is younger than 18 years old

Response Formats

  "OrganizationId": 77132,
  "AccountId": 818188,
  "AccountOwnerId": 398313,
  "AccountOwnerFirstName": "Mario",
  "AccountOwnerLastName": "Viau",
  "AccountOwnerFullName": "Mario Viau",
  "AccountOwnerEmail": "",
  "AccountOwnerTelephoneMobile": null,
  "IsArchived": false,
  "Contacts": [
      "Relationship": "Grandmother",
      "Type": "EmergencyContact",
      "Id": 0,
      "FirstName": "Georgette",
      "LastName": "Plouffe",
      "FullName": "Georgette Plouffe",
      "DateOfBirth": null,
      "Email": "",
      "Telephone": "514 555 9999",
      "TelephoneMobile": null,
      "TelephoneWork": null
  "Skills": [
      "Id": 88,
      "Name": "Rescue",
      "AwardedDate": "2022-09-01"
  "MedicalInformation": {
    "Allergies": {
      "Nuts": false,
      "Peanuts": false,
      "Eggs": false,
      "InsectSting": false,
      "Seafood": false
    "Sicknesses": {
      "Asthma": false,
      "Incontinence": false,
      "HearingDisorder": false,
      "Diabete": false,
      "Hyperactive": false,
      "Epilepsy": false,
      "VisualDisorder": false,
      "MotorHandicap": false,
      "BehaviorDisorder": false
    "Reactions": "Rash",
    "MedicationDosage": "20 mg",
    "MedicationFrequency": "Twice daily",
    "MedicationOther": "Take with meals",
    "OtherAllergy": "Crab",
    "OtherSickness": "Sea sickness",
    "MedicalStatus": "NoRecord",
    "HasSickness": false,
    "HasAllergy": false
  "JoinDate": "2022-09-01",
  "PictureUrl": "photo_de_maurice.jpg",
  "Memberships": [
      "Id": 54321
      "Id": 12345
  "ExternalId": "MyId85884",
  "Friend": null,
  "PickupPassword": null,
  "Id": 0,
  "FirstName": "Maurice",
  "LastName": "Maynard",
  "FullName": "Maurice Maynard",
  "Gender": "Male",
  "DateOfBirth": "2000-02-20",
  "Email": "",
  "Address": {
    "Latitude": 45.72,
    "Longitude": -73.5,
    "Address1": "412 des Érables",
    "Address2": "App. 1",
    "City": "Montreal",
    "Country": "Canada",
    "StateProvince": "QC",
    "ZipPostalCode": "H3G 1A1"
  "Telephone": "514 555 5555",
  "TelephoneMobile": "438 555 0000",
  "TelephoneWork": "438 555 5555",
  "TelephoneWorkExtension": "1234",
  "IsChild": false