users v1

Get Current Profile

Get the current Users profile.

get/v1/users/me

Response

The users profile

_idstring required
usernamestring required
emailstring required
firstNamestring required
lastNamestring required
isAdminboolean required
favouritesstring[] required
archivedProjectsstring[] required
createdBystring required
isServiceAccountboolean required
clmIdstring required
groupsstring[] required
projectAdministratorOfstring[] required
projectKeyUserOfstring[] required
administratorOfstring[] required
favouritesCountinteger required
recentActivitiesCountinteger required

Example response

{
  "_id": "593952659364f5150f12cad9",
  "username": "chris.swaine@causeway.com",
  "email": "chris.swaine@causeway.com",
  "firstName": "Chris",
  "lastName": "Swaine",
  "isAdmin": true,
  "favourites": [
    "6005dc19f66c56d8d1f9408a"
  ],
  "organisations": [
    {
      "_id": "593954c3331fc5160531987f",
      "deleted": false,
      "name": {
        "value": "Chris's Contracting",
        "form": {
          "fieldType": "string",
          "required": true,
          "_id": "593954c3331fc51605319881"
        }
      },
      "rootNode": "593954c3331fc51605319883",
      "type": 10,
      "clmId": {
        "value": "6af7ea13-56f5-4850-bc04-b37b2189cef8",
        "form": {
          "fieldType": "string",
          "required": false,
          "_id": "5b28de12bcd551288642a115"
        }
      },
      "processLibraryCreated": true,
      "maxProjects": {
        "form": {
          "_id": "5f4e3123dd812e5b24a02833",
          "required": true,
          "fieldType": "number"
        },
        "value": 9999
      },
      "keyUsers": [
        "5b62b79cb4477d000f33ffc2",
        "5a9f74907402c415781d6d52",
        "60b8b2295a7480640928cde5"
      ],
      "invoiceFilingStructure": [],
      "createdDate": "2017-06-08T13:44:35.933Z",
      "invoiceProcessMapping": {
        "conditions": [],
        "_id": "6070772cf0f3c6868bb06d66",
        "metaGroup": "59396620ecfe90193a68e8a3",
        "process": {
          "mappings": [
            {
              "processVarName": "user_r_reviewer",
              "roleVal": null,
              "userVal": "59411532261b124bcc72a726",
              "metaTag": null,
              "_id": "60f67a9c0ce66b6ab5c7bd88"
            },
            {
              "processVarName": "string_r_status",
              "roleVal": null,
              "userVal": null,
              "metaTag": "5b51bc76fc6c56000f30432c",
              "_id": "60f67a9c0ce66b5611c7bd87"
            }
          ],
          "_id": "60f67b180ce66b460fc7bf59",
          "definitionId": "InternalDocumentReview.InternalDocumentReview",
          "deploymentId": "593954c3331fc5160531987f:InternalDocumentReview:1.0"
        }
      },
      "restrictedUsers": [
        "60f67b180ce66b460fc7bf59"
      ]
    }
  ],
  "projects": [
    {
      "_id": "59e890af4253f94c31e70f73",
      "deleted": false,
      "type": 20,
      "projectSettings": {
        "formOfContract": "NEC3",
        "value": 0,
        "description": "Default Project",
        "status": "",
        "owner": {
          "_id": "593954c3331fc5160531987f",
          "deleted": false,
          "name": {
            "value": "Chris's Contracting",
            "form": {
              "fieldType": "string",
              "required": true,
              "_id": "593954c3331fc51605319881"
            }
          },
          "type": 10,
          "clmId": {
            "value": "6af7ea13-56f5-4850-bc04-b37b2189cef8",
            "form": {
              "fieldType": "string",
              "required": false,
              "_id": "5b28de12bcd551288642a115"
            }
          },
          "processLibraryCreated": true,
          "maxProjects": {
            "form": {
              "_id": "5f4e3123dd812e5b24a02833",
              "required": true,
              "fieldType": "number"
            },
            "value": 9999
          },
          "keyUsers": [
            "5b62b79cb4477d000f33ffc2",
            "5a9f74907402c415781d6d52",
            "60b8b2295a7480640928cde5"
          ],
          "createdDate": "2017-06-08T13:44:35.933Z",
          "invoiceProcessMapping": {
            "conditions": [],
            "_id": "6070772cf0f3c6868bb06d66",
            "metaGroup": "59396620ecfe90193a68e8a3",
            "process": {
              "mappings": [
                {
                  "processVarName": "user_r_reviewer",
                  "roleVal": null,
                  "userVal": "59411532261b124bcc72a726",
                  "metaTag": null,
                  "_id": "60f67a9c0ce66b6ab5c7bd88"
                },
                {
                  "processVarName": "string_r_status",
                  "roleVal": null,
                  "userVal": null,
                  "metaTag": "5b51bc76fc6c56000f30432c",
                  "_id": "60f67a9c0ce66b5611c7bd87"
                }
              ],
              "_id": "60f67b180ce66b460fc7bf59",
              "definitionId": "InternalDocumentReview.InternalDocumentReview",
              "deploymentId": "593954c3331fc5160531987f:InternalDocumentReview:1.0"
            }
          },
          "restrictedUsers": [
            "60f67b180ce66b460fc7bf59"
          ]
        },
        "_id": "59e890af4253f94c31e70f74"
      },
      "name": {
        "value": "Causeway House",
        "form": {
          "fieldType": "string",
          "required": true,
          "_id": "59e890af4253f94c31e70f76"
        }
      },
      "rootNode": "59e890af4253f94c31e70f78",
      "processLibraryCreated": true,
      "invoiceFilingStructure": [],
      "keyUsers": [],
      "createdDate": "2017-10-19T11:46:55.809Z"
    }
  ],
  "preferences": [
    {
      "pref": "emailTaskNotifications",
      "value": true,
      "_id": "5cc87d3ebe2d6b128c6f52de"
    }
  ],
  "delegations": [
    {
      "ou": "593954c3331fc5160531987f",
      "enabled": false,
      "user": {
        "_id": "59411532261b124bcc72a726",
        "username": "mark.greatorex@causeway.com",
        "email": "mark.greatorex@causeway.com",
        "firstName": "Mark",
        "lastName": "Greatorex",
        "favourites": [
          "593954c3331fc51605319883",
          "5f47814692dfcbec8d8c0be1",
          "5f47819c92dfcb5ade8c237e",
          "5f477f2692dfcb843a8bb0f9",
          "6078434cfc354b01d0e540c9",
          "5f8d833e9c2f3d7e9cd38de4"
        ],
        "createdBy": "5ebe8c6f53bea6bced5b51fe"
      },
      "_id": "5d7bceefc0ddf137aea81619"
    }
  ],
  "archivedProjects": [
    "5e6115b46d42232dee988b48"
  ],
  "createdBy": "5ebe8c6f53bea6bced5b51fe",
  "isServiceAccount": false,
  "clmId": "7055095b-5ef1-4a2b-b730-63b079576aa5",
  "groups": [
    "593954c3331fc51605319889"
  ],
  "projectAdministratorOf": [
    "59e890af4253f94c31e70f73"
  ],
  "projectKeyUserOf": [
    "5cee1e34cbabe93c12725125"
  ],
  "projectRestrictedUserOf": [
    "60f67b180ce66b460fc7bf59"
  ],
  "administratorOf": [
    "593954c3331fc5160531987f"
  ],
  "keyUserOf": [
    "60f67b180ce66b460fc7bf59"
  ],
  "restrictedUserOf": [
    "60f67b180ce66b460fc7bf59"
  ],
  "favouritesCount": 3,
  "recentActivitiesCount": 30,
  "ouActivity": [
    {
      "_id": "593954c3331fc5160531987f",
      "time": "2023-01-04T00:00:06.471Z"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.