End User Accounts

Get an end-user account

Retrieve details for a single end-user account.

get/v2/{tenant_slug}/enduseraccounts/{website_account_id}

Request

Base URL
https://api.demo-retail.urbanfox.io
Auth
OAuth 2
Client credentials
Token URLhttps://api.demo-retail.urbanfox.io/v2/oauth/token
Scopesread:enduseraccount
TypeScript
https://skmtc.dev/urbanfox/apis/urbanfox-customer-api/docs/v2/:tenant_slug/enduseraccounts/:website_account_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

tenant_slugstring required

Tenant DNS slug (lowercase letters, digits, and hyphens; 3-100 characters).

Example:demo-retail

website_account_idstring required

Identifier of the end-user's website account; the literal string UNKNOWN addresses accounts whose website identifier could not be resolved.

Example:account-abc123

Response

Successful Response

Example response

{
  "data": {
    "tenant_id": "00000000-0000-4000-8000-000000000000",
    "website_account_id": "account-abc123",
    "crm_account_id": "crm-abc456",
    "last_session_updated_on": "2024-01-15T10:30:00Z"
  }
}

Changes

No recorded changes to this operation across all 8 revisions of this API.