Validate Auth

GET /

Validate Authorization and Get Tenant Details

Responses

200 application/json

Valid Credentials
Hide response attributes Show response attributes object
- account_id string(guid)
- company_name string
- site object
  
  Hide site attributes Show site attributes object
  
  id string(guid)
  
  name string
  
  subdomain string
  
  Storefront can be accessed using this subdomain. Example, acme-corp.getfoundation.store
  
  custom_domain string
401 application/json

Unauthorized
Hide response attributes Show response attributes object
- error string
  
  401: Invalid Credentials
  
  404: Resource not found
  
  422: Unprocessable Entity
- details string
  
  404: empty
  
  401: The credentials presented are not valid to access this resource

GET /

curl \
 --request GET 'https://app.getfoundation.com/api/external/v1/' \
 --header "X-API-Key: $API_KEY"

Response examples (200)

{
  "account_id": "9aa62446-c3b0-42f5-8027-3648daed9d73",
  "company_name": "Foundation",
  "site": {
    "id": "9aa62446-c3b0-42f5-8027-3648daed9d73",
    "name": "Foundation",
    "subdomain": "acme-corp",
    "custom_domain": "wholesale.acme-corp.com"
  }
}

Response examples (401)

{
  "error": "string",
  "details": "string"
}