Get the details about the current user, their deployment and access token.
GET /user
For getting details regarding the staff object associated with the current user, please see the get staff endpoint.
Handling the Response
| Key | Type | Description |
|---|---|---|
| user_access | hash | A key-value object containing manages, add, view and admin permissions for the different types of objects. See the example below for more information. |
| user_titles | hash | A key-value object containing the user defined plural and singular titles for each object type. |
| locale.currency.symbol | string | The string symbol for the deployments currency. Defaults to "$". |
Example
{
"meta": {
"message": "Everything executed as expected.",
"more_info": "https://affinitylive.jira.com/wiki/display/APIS/Status+Codes#ok",
"status": "ok"
},
"response": [
{
"name": "locale",
"currency": {
"symbol": "$"
}
},
{
"name": "user_access",
"company": {
"add": "1",
"admin": "1",
"manages": "0",
"view": "1"
},
"contact": {
"add": "1",
"admin": "1",
"manages": "0",
"view": "1"
},
"contract": {
"add": "1",
"admin": "1",
"manages": "0",
"view": "1"
},
"expense": {
"add": "1",
"admin": "1",
"manages": "0",
"view": "1"
},
"invoice": {
"add": "1",
"admin": "1",
"manages": "0",
"view": "1"
},
"issue": {
"add": "1",
"admin": "1",
"manages": "0",
"view": "1"
},
"job": {
"add": "1",
"admin": "1",
"manages": "0",
"view": "1"
},
"prospect": {
"add": "1",
"admin": "1",
"manages": "0",
"view": "1"
}
},
{
"name": "user_titles",
"account_invoice": {
"plural": "invoices",
"singular": "invoice"
},
"affiliation": {
"plural": "Affiliations",
"singular": "Affiliation"
},
"authorities": {
"plural": "authorities",
"singular": "authorities"
},
"campaign": {
"plural": "Campaigns",
"singular": "Campaign"
},
"campaign_action": {
"plural": "Campaign Communications",
"singular": "Campaign Communication"
},
"company": {
"plural": "Clients",
"singular": "Client"
},
"contract": {
"plural": "Retainers",
"singular": "Retainer"
},
"contract_period": {
"plural": "Retainer Periods",
"singular": "Retainer Period"
},
"deployment": {
"plural": "Deployments",
"singular": "Deployment"
},
"division": {
"plural": "Divisions",
"singular": "Division"
},
"estimate": {
"plural": "EstimatesA",
"singular": "EstimateA"
},
"expense": {
"plural": "Expenses",
"singular": "Expense"
},
"issue": {
"plural": "Issues",
"singular": "Issue"
},
"job": {
"plural": "Projects",
"singular": "Project"
},
"locations": {
"plural": "locations",
"singular": "locations"
},
"milestone": {
"plural": "Milestones",
"singular": "Milestone"
},
"period": {
"plural": "Periods",
"singular": "Period"
},
"prospect": {
"plural": "Sales",
"singular": "Sale"
},
"quote": {
"plural": "Quotes",
"singular": "Quote"
},
"request": {
"plural": "Requests",
"singular": "Request"
},
"sites": {
"plural": "sites",
"singular": "sites"
},
"task": {
"plural": "Tasks",
"singular": "Task"
}
}
]
}