Contents x
    Get User
    • 19 Jan 2024
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Get User

    • Updated on 19 Jan 2024
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    User

    Get /user/{externalId}
    Finding users not supported

    Getting all users or searching for users is currently not supported.
    This /user/ method enables your other system to retrieve information for users previously created via the API.
    (As these users are known in your system, so far there has been no need to retrieve these users.)

    NameData TypeDescription
    Content-type:application/jsonfor all requests
    Authorization:EAPI {token}for all requests

    Request Parameters

    Parameters indicated with a * are mandatory

    ParameterTypeDescription
    externalId*StringThe external ID of a user that needs to be fetched. The externalID corresponds with the 'User ID' within the usermanagement.

    Sample successful Response

    Deprecated: SynchronizationKey is no longer in use (and only kept for backward compatibility)

    {
  "Success": true,
  "Errors": null,
  "Content": {
    "User": {
      "ExternalId": "cirrus_user_ext_id",
      "LastName": "Miller",
      "FirstName": "John",
      "Email": "cirrus_user@gmail.com",
      "UserName": "cirrus_user",
      "Role": "string",
      "Photo": "https://cirrusplatform.com/static/img/default-avatar.png",
      "DateOfBirth": "1988-05-03",
      "Company": "Cirrus",
      "CountryCode": "EN",
      "State": "LA",
      "City": "London",
      "PostalCode": "12345A",
      "PostalAddress": "Platform 9 3/4, Hogwarts",
      "AddressLine1": "Address line 1",
      "AddressLine2": "Address line 1",
      "PhoneNumber": "345 123 234",
      "CellularPhone": "+534 64538 7665",
      "SpecialNeeds": true,
      "ReasonableAdjustmentPercentage": 75,
      "EnableReadSpeaker": true,
      "DisableLogin": true,
      "DisablePasswordReset": true,
      "SynchronizationKey": "0c824cc1-8294-4857-81cb-8327d83df554",
      "Labels": [
        "Label 1"
      ],
      "AllowedIpAddresses": [
        "192.168.1.1"
      ],
      "Hierarchies": [
        {
          "ExternalId": "cirrus_group_ext_id",
          "IsCoordinator": true,
          "IsAdministrator": true,
          "HasViewReportsPermissions": true,
          "HasReScoringPermissions": true,
          "GroupTitle": "Group A",
          "GroupPath": "Root Group / Group A",
          "GroupIsOrganization": true
        }
      ]
    }
  }
}

    Unsuccesfull response

    {
  "Success": false,
  "Errors": "User has not been found",
  "ErrorDetails": [
    {
      "Code": 202,
      "Error": "User has not been found"
    }
  ]
}

    Responses

    CodeDescription
    200Successful operation
    400Possible error codes:
    102: Unknown error
    202: User has not been found
    403Not allowed to use external API
    500Internal server error
    Was this article helpful?
    What's Next