Versions Compared

Old Version 3

changes.mady.by.user Kurt Wagner

Saved on

compared with

New Version 4

changes.mady.by.user Kurt Wagner

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning
titleUnreleased

This endpoint has limited availability and will be released in the next minor version.

Get the details about the current user, their deployment and access token.

...

For getting details regarding the staff object associated with the current user, please see the get staff endpoint.

Handling the Response

KeyTypeDescription
user_accesshashA key-value object containing manages, add, view and admin permissions for the different types of objects. See the example below for more information.
user_titleshashA key-value object containing the user defined plural and singular titles for each object type.
locale.currency.symbolstringThe string symbol for the deployments currency. Defaults to "$".

Example

Code Block
languagexml
<data>{
   "meta": {
     <meta "message=": "Everything executed as expected.",
      "more_info=": "https://affinitylive.jira.com/wiki/display/APIS/Status+Codes#ok",
status="ok"/>      "status": "ok"
   },
   "response": [
      {
        <response "name=": "locale">,
         "currency": {
           <currency "symbol=": "$"/>
         }
      },
      {
    </response>    <response "name=": "user_access">,
         "company": {
           <company "add=": "1",
admin=            "admin": "1",
     manages=       "manages": "0",
     view="1"/>       "view": "1"
         },
         "contact": {
           <contact "add=": "1",
        admin=    "admin": "1",
manages=            "manages": "0",
view="1"/>            "view": "1"
         },
         "contract": {
           <contract "add=": "1",
admin=            "admin": "1",
manages=            "manages": "0",
          view="1"/>  "view": "1"
         },
         "expense": {
           <expense "add=": "1",
            "admin=": "1",
            "manages=": "0",
    view="1"/>        "view": "1"
         },
         "invoice": {
           <invoice "add=": "1",
       admin=     "admin": "1",
manages=            "manages": "0",
view="1"/>            "view": "1"
         },
         "issue": {
           <issue "add=": "1",
admin=            "admin": "1",
manages=            "manages": "0",
         view="1"/>   "view": "1"
         },
         "job": {
           <job "add=": "1",
            "admin=": "1",
            "manages=": "0",
   view="1"/>         "view": "1"
         },
         "prospect": {
           <prospect "add=": "1",
      admin=      "admin": "1",
manages=            "manages": "0",
view="1"/>
   </response>            "view": "1"
         }
      },
      {
        <response "name=": "user_titles">,
         <account"account_invoice": {
  plural=          "plural": "invoices",
singular="invoice"/>            "singular": "invoice"
         },
         "affiliation": {
           <affiliation "plural=": "Affiliations",
singular="Affiliation"/>            "singular": "Affiliation"
         },
         "authorities": {
           <authorities "plural=": "authorities",
       singular="authorities"/>     "singular": "authorities"
         },
         "campaign": {
           <campaign "plural=": "Campaigns",
 singular="Campaign"/>           "singular": "Campaign"
         },
         <campaign"campaign_action": {
            "plural=": "Campaign Communications",
            "singular=": "Campaign Communication"/>
         },
         "company": {
           <company "plural=": "Clients",
       singular="Client"/>     "singular": "Client"
         },
         "contract": {
           <contract "plural=": "Retainers",
          singular=  "singular": "Retainer"/>
         },
         <contract"contract_period": plural={
            "plural": "Retainer Periods",
singular=            "singular": "Retainer Period"/>"
         },
         "deployment": {
           <deployment "plural=": "Deployments",
        singular="Deployment"/>    "singular": "Deployment"
         },
         "division": {
           <division "plural=": "Divisions",
  singular="Division"/>          "singular": "Division"
         },
         "estimate": {
           <estimate "plural=": "EstimatesA",
     singular="EstimateA"/>       "singular": "EstimateA"
         },
         "expense": {
           <expense "plural=": "Expenses",
        singular="Expense"/>    "singular": "Expense"
         },
         "issue": {
           <issue "plural=": "Issues",
 singular="Issue"/>           "singular": "Issue"
         },
         "job": {
           <job "plural=": "Projects",
singular="Project"/>            "singular": "Project"
         },
         "locations": {
           <locations "plural=": "locations",
         singular="locations"/>   "singular": "locations"
         },
         "milestone": {
           <milestone "plural=": "Milestones",
   singular="Milestone"/>         "singular": "Milestone"
         },
         "period": {
           <period "plural=": "Periods",
      singular="Period"/>      "singular": "Period"
         },
         "prospect": {
           <prospect "plural=": "Sales",
         singular="Sale"/>   "singular": "Sale"
         },
         "quote": {
           <quote "plural=": "Quotes",
            "singular="Quote"/>": "Quote"
         },
         "request": {
           <request "plural=": "Requests",
singular="Request"/>            "singular": "Request"
         },
         "sites": {
           <sites "plural=": "sites",
singular="sites"/>            "singular": "sites"
         },
         "task": {
           <task "plural=": "Tasks",
            "singular=": "Task"/>
         }
      }
   </response>
</data>]
}