Link Search Menu Expand Document

Updated Thu Sep 23rd 2021, 13:14 UTC

Get Profile

GET /profile

A profile is information that pertains to the current user

Examples

Get the current User’s Profile

Request

GET /profile
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X GET /profile
    

Response

Status

200

Response Type

User

Example
{
  "@type": "User",
  "id": "/users/oNPpON",
  "@context": "/contexts/User.jsonld",
  "name": "Chuck Norris",
  "firstName": "Chuck",
  "lastName": "Norris",
  "email": "chuck@textus.example",
  "avatar": null,
  "hasPassword": false,
  "discarded": false,
  "memberships": {
    "@type": "hydra:Collection",
    "id": "/users/oNPpON/memberships",
    "@context": "/contexts/hydra:Collection.jsonld",
    "totalItems": 1,
    "members": [
      {
        "@type": "Membership",
        "id": "/users/oNPpON/memberships/wqyODPA",
        "@context": "/contexts/Membership.jsonld",
        "role": "admin",
        "user": "/users/oNPpON",
        "account": {
          "@type": "Account",
          "@context": "/contexts/Account.jsonld",
          "id": "/accounts/child_account",
          "name": "child_account",
          "slug": "child_account",
          "multiUser": false,
          "type": "standard",
          "contactImport": "/child_account/contacts/import",
          "contacts": "/child_account/contacts",
          "conversationFilters": "/child_account/conversation_filters",
          "campaignFilters": "/child_account/campaign_filters",
          "contactFilters": "/child_account/contact_filters",
          "conversations": "/child_account/conversations/{phoneNumber}{?contactPhone}",
          "inbox": "/child_account/inbox",
          "campaigns": "/child_account/campaigns",
          "presignAttachment": "/child_account/attachments/sign",
          "presignContactImport": "/child_account/contacts/import/generate_signed_url",
          "contactPhones": "/child_account/contact_phones",
          "sendMessages": "/child_account/messages",
          "scheduleMessages": "/child_account/messages/schedule",
          "users": "/child_account/users",
          "navbar": "/navbar/child_account",
          "signedAvatarUrl": "/users/signed_avatar_url",
          "children": "/accounts/child_account/children",
          "analytics": "/accounts/my_account/analytics",
          "optOutAnalytics": "/my_account/opt_outs/analytics",
          "optOuts": "/my_account/opt_outs",
          "exportOptOuts": "/my_account/opt_outs/export",
          "optOutImport": "/my_account/opt_outs/upload",
          "presignOptOutImport": "/my_account/opt_outs/sign",
          "userSchema": "/textus/user_schema",
          "adminUserSchema": null,
          "logo": null,
          "familyCount": 1,
          "childrenCount": 0,
          "featureFlags": {
            "campaignUiGroups": false,
            "whiteLabelEnabled": false,
            "emphasizeUnansweredCounts": false,
            "pusherRefreshFlag": false,
            "campaignAttachments": false,
            "workdayIntegrationFlag": false
          },
          "signedWhitelabelUrl": "/accounts/signed_whitelabel_url",
          "phoneNumbers": [
            "(303) 555-1111"
          ],
          "integrations": "/my_account/integrations",
          "contactsEnabled": true,
          "settings": {
            "maxCampaignRecipients": {
              "value": 100,
              "locked": false,
              "setAtAccount": "/accounts/my_account",
              "lockedAtAccount": {
                "id": null,
                "name": null
              },
              "disabled": false
            },
            "dailyCampaignRecipients": {
              "value": 100,
              "locked": false,
              "setAtAccount": "/accounts/my_account",
              "lockedAtAccount": {
                "id": null,
                "name": null
              },
              "disabled": false
            },
            "conversationAutoCloseAfter": {
              "disabled": false,
              "locked": false,
              "lockedAtAccount": {
                "id": null,
                "name": null
              },
              "setAtAccount": "/accounts/my_account",
              "value": -1
            },
            "countryCode": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "contactImportTarget": {
              "value": true,
              "locked": false,
              "setAtAccount": "/accounts/my_account",
              "lockedAtAccount": {
                "id": null,
                "name": null
              },
              "disabled": false
            },
            "unassignClosedConversationsAfter": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "unassignOpenConversationsAfter": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "forwardingNumberDisabled": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "forwardingNumber": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "inboundMmsDisabled": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "outboundMmsDisabled": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "stripInboundLinks": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "stripOutboundLinks": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "introMessageEnabled": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "introMessage": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "officeHours": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "campaignDeliveryCutoffTime": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "campaignDeliveryCutoffTimeEnabled": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "timeZone": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "avaloId": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "voiceEnabled": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "conversationExportsEnabled": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "primaryColor": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "secondaryColor": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "tertiaryColor": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "outboundMessageColor": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "accountImageUrl": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "sharedOptOutsTarget": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "legalEntity": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "appendedMessageEnabled": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "appendedMessage": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "autoReplyMessageEnabled": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "autoReplyMessage": {
              "setAtAccount": "/accounts/my_account",
              "disabled": false
            },
            "companyName": {
              "disabled": false,
              "setAtAccount": "/accounts/my_account"
            },
            "companyFooter": {
              "disabled": false,
              "setAtAccount": "/accounts/my_account"
            },
            "product": {
              "disabled": false,
              "setAtAccount": "/accounts/my_account"
            },
            "supportLink": {
              "disabled": false,
              "setAtAccount": "/accounts/my_account"
            },
            "preferredDomain": {
              "disabled": false,
              "setAtAccount": "/accounts/my_account",
              "value": "www.example.com",
              "locked": false,
              "lockedAtAccount": {
                "id": null,
                "name": null
              }
            },
            "oneSignalAppId": {
              "disabled": false,
              "setAtAccount": "/accounts/root"
            },
            "oneSignalApiKey": {
              "disabled": false,
              "setAtAccount": "/accounts/root"
            },
            "oneSignalBaseUrl": {
              "disabled": false,
              "setAtAccount": "/accounts/root"
            },
            "email": {
              "disabled": false,
              "setAtAccount": "/accounts/my_account"
            },
            "sendgridApiKey": {
              "disabled": false,
              "setAtAccount": "/accounts/my_account"
            },
            "oneSignalMobileAppId": {
              "disabled": false,
              "setAtAccount": "/accounts/my_account"
            },
            "oneSignalMobileApiKey": {
              "disabled": false,
              "setAtAccount": "/accounts/my_account"
            },
            "resellerId": {
              "disabled": false,
              "setAtAccount": "/accounts/my_account"
            }
          }
        }
      }
    ]
  },
  "automatedActor": false,
  "settings": {
    "notifications": {
      "email": true
    },
    "customSettings": {}
  },
  "uiConfig": {},
  "featureFlags": {},
  "signature": {
    "@type": "Signature",
    "id": "/users/oNPpON/signature",
    "@context": "/contexts/Signature.jsonld",
    "content": "Chuck Norris"
  },
  "savedReplies": "users/oNPpON/saved_replies",
  "hasSubAccounts": false,
  "topLevelAccounts": [
    "/accounts/my_account"
  ],
  "tosAcceptedAt": null,
  "gettingStartedElements": {
    "@type": "hydra:Collection",
    "@context": "/contexts/hydra:Collection.jsonld",
    "id": "/getting_started",
    "members": [
      {
        "@type": "GettingStartedElement",
        "@context": "/contexts/GettingStartedElement.jsonld",
        "id": "/getting_started/set_your_avatar",
        "elementType": "set_your_avatar",
        "record": null
      },
      {
        "@type": "GettingStartedElement",
        "@context": "/contexts/GettingStartedElement.jsonld",
        "id": "/getting_started/update_account_settings/my_account",
        "elementType": "update_account_settings",
        "record": "/accounts/my_account"
      }
    ],
    "totalItems": 2
  }
}

© 2021 TextUs