Get All Linked User Accounts

Gets all user accounts that are linked to the currently logged in civicID user.

Resource Information

Scopecivicid

Deprecated scope name:   get_linked_accounts

App TypeAll
Authorization TypeAccess token
URI /v4/civicid/accounts?lang={lang}
HTTP MethodGET
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
langStringNo Indicates the language applied.7.3.2

Response Information

FieldTypeDescriptionAutomation Version
resultresult{} 7.3.2
result.agencyAccounts[]result.agencyAccounts{}The agency user accounts associated with the civic ID.7.3.2
result.agencyAccounts.agencyDisplayNamestringThe name of the agency, as displayed in the application.7.3.2
result.agencyAccounts.agencyNamestringThe name that identifies the agency.7.3.2
result.agencyAccounts.idstringThe account userid.7.3.2
result.agencyAccounts.namestringThe full name for the application contact.7.3.2
result.citizenAccounts[]result.citizenAccounts{}The citizen user accounts associated with the civic ID.7.3.2
result.citizenAccounts.agencyDisplayNamestringThe name of the agency, as displayed in the application.7.3.2
result.citizenAccounts.agencyNamestringThe name that identifies the agency.7.3.2
result.citizenAccounts.idstringThe account userid.7.3.2
result.citizenAccounts.namestringThe full name for the application contact.7.3.2
result.socialAccounts[]result.socialAccounts{}Includes account parameters for the social accounts to link to (Facebook, Twitter, and so forth).7.3.2
result.socialAccounts.agencyDisplayNamestringThe name of the agency, as displayed in the application.7.3.2
result.socialAccounts.agencyNamestringThe name that identifies the agency.7.3.2
result.socialAccounts.idstringThe account userid.7.3.2
result.socialAccounts.namestringThe full name for the application contact.7.3.2
statusintegerThe record status.7.3.3

Example

Sample Response Body

{
  "result": {
    "socialAccounts": [],
    "agencyAccounts": [],
    "cityPortalAccounts": [
      {
        "id": "2e6c2699-ecf5-4a2f-b272-38f86a394092",
        "name": "apitester@accela.com",
        "agencyName": "ISLANDTON-APP",
        "agencyDisplayName": "ISLANDTON Sandbox for App Developers"
      }
    ]
  }
}