Get CivicID Profile

Gets the profile for the currently logged in civicID user.

Resource Information

Scopecivicid

Deprecated scope name:   get_civicid_profile

App TypeAll
Authorization TypeAccess token
URI /v4/civicid/profile?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.avatarUrlstringThe URL for the user's avatar.7.3.2
result.citystringThe name of the city.7.3.2
result.countryCodestringThe country code for phone and fax numbers.7.3.2
result.emailstringThe contact's email address.7.3.2
result.firstNamestringThe contact's first name. This field is only active when the Contact Type selected is Individual.7.3.2
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.lastNamestringThe last name (surname). 7.3.2
result.loginNamestringThe login name for the public user.7.3.2
result.phoneAreaCodestringThe area code for the assoicated phone number.7.3.2
result.phoneCountryCodestringThe country code for the assoicated phone number.7.3.2
result.phoneNumberstringA user's phone number.7.3.2
result.postalCodestringThe postal ZIP code for the address.7.3.2
result.statestringThe state corresponding to the address on record.7.3.2
result.streetAddressstringThe street address. 7.3.2
statusintegerThe record status.7.3.3

Example

Sample Response Body

{
  "result": {
    "id": "2e6c2699-ecf5-4a2f-b272-38f86a394092",
    "loginName": "apitester@accela.com",
    "email": "apitester@accela.com",
    "firstName": "API",
    "lastName": "Tester",
    "countryCode": "US",
    "streetAddress": "2633 Camino Ramon Suite 500",
    "city": "San Ramon",
    "state": "CA",
    "postalCode": "94583",
    "phoneAreaCode": "925",
    "phoneNumber": "6593200"
  }
}