Back to endpoints

Get accounts

GET api/V3/{language}/org/{orgIdentifier}/accounts

?accountOwnerEmail={accountOwnerEmail}

&showArchived={showArchived}

&page={page}

&perPage={perPage}

Returns a list of all accounts sorted by id, with the option to show archived accounts

Request Information

URI Parameters

PARAMETERS
language (string)

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

Required
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'.

Required
accountOwnerEmail (string)

No description available

Optional
showArchived (boolean)

Option to also show archived items.

Default value is False

Optional
page (integer)

Result page number that appears first.

Default value is 1

Optional
perPage (integer)

Number of results per page.

Default value is 200

Optional

Body Parameters

None.

Response Information

Resource Description

PARAMETERS
Id (integer)

Resource id

Owners ()

Account owners

Members ()

Account members

Corporate (CorporateApiModelV3)

Corporate account details

AccountMemberships ()

Response Formats

CODE SAMPLE JSON
[
  {
    "Id": 0,
    "Owners": [
      {
        "OrganizationId": 77132,
        "AccountId": 818188,
        "AccountOwnerId": 398313,
        "AccountOwnerFirstName": "Mario",
        "AccountOwnerLastName": "Viau",
        "AccountOwnerFullName": "Mario Viau",
        "AccountOwnerEmail": "mario@monadresse.ca",
        "AccountOwnerTelephoneMobile": null,
        "IsArchived": false,
        "Contacts": [
          {
            "Relationship": "Grandmother",
            "Type": "EmergencyContact",
            "Id": 0,
            "FirstName": "Georgette",
            "LastName": "Plouffe",
            "FullName": "Georgette Plouffe",
            "DateOfBirth": null,
            "Email": "allo@videotron.ca",
            "Telephone": "514 555 9999",
            "TelephoneMobile": null,
            "TelephoneWork": null
          }
        ],
        "Skills": [
          {
            "Id": 88,
            "Name": "Rescue",
            "AwardedDate": "2022-08-13"
          }
        ],
        "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-08-13",
        "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": "mau@gmail.com",
        "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
      }
    ],
    "Members": [
      {
        "OrganizationId": 77132,
        "AccountId": 818188,
        "AccountOwnerId": 398313,
        "AccountOwnerFirstName": "Mario",
        "AccountOwnerLastName": "Viau",
        "AccountOwnerFullName": "Mario Viau",
        "AccountOwnerEmail": "mario@monadresse.ca",
        "AccountOwnerTelephoneMobile": null,
        "IsArchived": false,
        "Contacts": [
          {
            "Relationship": "Grandmother",
            "Type": "EmergencyContact",
            "Id": 0,
            "FirstName": "Georgette",
            "LastName": "Plouffe",
            "FullName": "Georgette Plouffe",
            "DateOfBirth": null,
            "Email": "allo@videotron.ca",
            "Telephone": "514 555 9999",
            "TelephoneMobile": null,
            "TelephoneWork": null
          }
        ],
        "Skills": [
          {
            "Id": 88,
            "Name": "Rescue",
            "AwardedDate": "2022-08-13"
          }
        ],
        "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-08-13",
        "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": "mau@gmail.com",
        "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
      }
    ],
    "Corporate": {
      "Id": 0,
      "CompanyName": "Acme Inc.",
      "Email": "acme@acme.com",
      "Address": {
        "Latitude": 45.72,
        "Longitude": -73.5,
        "Address1": "32 Seymour Street",
        "Address2": "",
        "City": "Kamloops",
        "Country": "Canada",
        "StateProvince": "BC",
        "ZipPostalCode": "V2C 2A1"
      },
      "PictureUrl": "img/ourbusiness.jpg",
      "Website": "www.acme.com",
      "Telephone": "555 555 5555",
      "TelephoneOther": "555 444 3333",
      "OrganizationId": 0,
      "AccountId": 0,
      "IsArchived": false,
      "Contact": {
        "FirstName": "Edgar",
        "LastName": "Smith",
        "Title": "Chief Officer",
        "Email": "esmith@acme.com",
        "Telephone": "555 444 3210"
      }
    }
  },
  {
    "Id": 0,
    "Owners": [
      {
        "OrganizationId": 77132,
        "AccountId": 818188,
        "AccountOwnerId": 398313,
        "AccountOwnerFirstName": "Mario",
        "AccountOwnerLastName": "Viau",
        "AccountOwnerFullName": "Mario Viau",
        "AccountOwnerEmail": "mario@monadresse.ca",
        "AccountOwnerTelephoneMobile": null,
        "IsArchived": false,
        "Contacts": [
          {
            "Relationship": "Grandmother",
            "Type": "EmergencyContact",
            "Id": 0,
            "FirstName": "Georgette",
            "LastName": "Plouffe",
            "FullName": "Georgette Plouffe",
            "DateOfBirth": null,
            "Email": "allo@videotron.ca",
            "Telephone": "514 555 9999",
            "TelephoneMobile": null,
            "TelephoneWork": null
          }
        ],
        "Skills": [
          {
            "Id": 88,
            "Name": "Rescue",
            "AwardedDate": "2022-08-13"
          }
        ],
        "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-08-13",
        "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": "mau@gmail.com",
        "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
      }
    ],
    "Members": [
      {
        "OrganizationId": 77132,
        "AccountId": 818188,
        "AccountOwnerId": 398313,
        "AccountOwnerFirstName": "Mario",
        "AccountOwnerLastName": "Viau",
        "AccountOwnerFullName": "Mario Viau",
        "AccountOwnerEmail": "mario@monadresse.ca",
        "AccountOwnerTelephoneMobile": null,
        "IsArchived": false,
        "Contacts": [
          {
            "Relationship": "Grandmother",
            "Type": "EmergencyContact",
            "Id": 0,
            "FirstName": "Georgette",
            "LastName": "Plouffe",
            "FullName": "Georgette Plouffe",
            "DateOfBirth": null,
            "Email": "allo@videotron.ca",
            "Telephone": "514 555 9999",
            "TelephoneMobile": null,
            "TelephoneWork": null
          }
        ],
        "Skills": [
          {
            "Id": 88,
            "Name": "Rescue",
            "AwardedDate": "2022-08-13"
          }
        ],
        "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-08-13",
        "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": "mau@gmail.com",
        "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
      }
    ],
    "Corporate": {
      "Id": 0,
      "CompanyName": "Acme Inc.",
      "Email": "acme@acme.com",
      "Address": {
        "Latitude": 45.72,
        "Longitude": -73.5,
        "Address1": "32 Seymour Street",
        "Address2": "",
        "City": "Kamloops",
        "Country": "Canada",
        "StateProvince": "BC",
        "ZipPostalCode": "V2C 2A1"
      },
      "PictureUrl": "img/ourbusiness.jpg",
      "Website": "www.acme.com",
      "Telephone": "555 555 5555",
      "TelephoneOther": "555 444 3333",
      "OrganizationId": 0,
      "AccountId": 0,
      "IsArchived": false,
      "Contact": {
        "FirstName": "Edgar",
        "LastName": "Smith",
        "Title": "Chief Officer",
        "Email": "esmith@acme.com",
        "Telephone": "555 444 3210"
      }
    }
  }
]