AFaffinity
Users

Get a single User

Changed on
⚠️ This endpoint is currently in BETA

Returns information about a single internal User, including name, primary email address, all email addresses, photo URL, account status, and account role.

The userId path parameter is the same identifier as the User's corresponding Person ID — every internal User has a matching Person record, and they share the same numeric ID. You can use a Person ID returned from any Persons endpoint here, and vice versa.

The emailAddresses and role properties are only returned to callers with the "Manage Users" permission.

get/v2/users/{userId}

Request

  • Base URL
    https://api.affinity.co
  • URL
    https://api.affinity.co/v2/users/{userId}
  • Auth
    HTTP bearer

Path parameters

userIdinteger required

User ID

Response

OK

idinteger required

The user's unique identifier

firstNamestring required

The user's first name

lastNamestring nullable required

The user's last name

primaryEmailAddressstring email nullable required

The user's primary email address

emailAddressesstring[]

All of the user's email addresses. Only returned when the authenticated user has the "Manage Users" permission.

photoUrlstring uri nullable required

URL of the user's profile photo

status'active' | 'invited' | 'deactivated' required

The user's account status.

  • active: the user can sign in and use Affinity.
  • invited: the user has been invited to the product but has not yet accepted the invitation and thus cannot have taken any actions.
  • deactivated: the user was once active but has been deactivated and can no longer use the product.
rolestring

The user's account role. Only returned when the authenticated user has the "Manage Users" permission.

Example response

{
  "id": 1,
  "firstName": "Jane",
  "lastName": "Doe",
  "primaryEmailAddress": "jane.doe@acme.co",
  "emailAddresses": [
    "jane.doe@acme.co",
    "janedoe@gmail.com"
  ],
  "photoUrl": "https://assets.affinity.co/img/avatars/jane-doe.png",
  "status": "active",
  "role": "standard"
}

Changes

  • 187749f77548Revision changes
    • info

      added authentication authorization bad-request conflict method-not-allowed not-acceptable not-found not-implemented rate-limit server timeout unprocessable-entity unsupported-media-type validation discriminator mapping keys to the / response property for the response status

    • info

      added bad-request validation discriminator mapping keys to the / response property for the response status