Users

Routes for managing users

Get User Details

GET/users/user/:userId

Retrieve details of a specific user by their user ID.

Required attributes

Name
userId
Type
string
Description
The id of the user you wish to load

cURL

    curl https://your.platform.url/api/gateway/users/user/501a4c57-acb8-40d6-b867-b833854a96b9 \
      -H "Authorization: Bearer {token}"

Sample Response

{
  "guid":"501a4c57-acb8-40d6-b867-b833854a96b9",
  "status":"Active",
  "username":"testuser",
  "contact": {
    "title":"Mr",
    "forename":"Test",
    "surname":"User",
    "fullName":"Mr Test User",
    "contactEmail": {
      "email":"test@user.com"
    },
    "dateCreated":null
  },
  "pivot":null,
  "data":[]
}

Update User

PATCH/users/:userId

Updates the details for a specific user.

Required attributes

Name
userId
Type
string
Description
The id of the user you wish to update

Body Parameters

Name
tile
Type
string
Description
The users title
Name
forename
Type
string
Description
The users forename
Name
surname
Type
string
Description
The users surname
Name
email
Type
string
Description
The users email address

cURL

    curl -X PATCH https://your.platform.url/api/gateway/users/8c63ce30-bb74-4910-9c2e-510fb3792d5e \
      -H "Authorization: Bearer {token}" \
      -H "Content-Type: application/json" \
      -d '{
        "title": "Mr",
        "forename": "John",
        "surname": "Doe",
        "email": "john.doe@example.com"
  }'