Get CivicID Profile

Gets the profile for the currently logged in civicID user.

Resource Information

Scope	civicid Deprecated scope name: get_civicid_profile
App Type	All
Authorization Type	Access token
URI	/v4/civicid/profile?lang={lang}
HTTP Method	GET
Automation Version(s)	7.3.2

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
lang	String	No	�	Indicates the language applied.	7.3.2

Response Information

Field	Type	Description	Automation Version
result	result{}	�	7.3.2
result.avatarUrl	string	The URL for the user's avatar.	7.3.2
result.city	string	The name of the city.	7.3.2
result.countryCode	string	The country code for phone and fax numbers.	7.3.2
result.email	string	The contact's email address.	7.3.2
result.firstName	string	The contact's first name. This field is only active when the Contact Type selected is Individual.	7.3.2
result.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.lastName	string	The last name (surname).	7.3.2
result.loginName	string	The login name for the public user.	7.3.2
result.phoneAreaCode	string	The area code for the assoicated phone number.	7.3.2
result.phoneCountryCode	string	The country code for the assoicated phone number.	7.3.2
result.phoneNumber	string	A user's phone number.	7.3.2
result.postalCode	string	The postal ZIP code for the address.	7.3.2
result.state	string	The state corresponding to the address on record.	7.3.2
result.streetAddress	string	The street address.	7.3.2
status	integer	The 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"
  }
}