Tenant Data API

Get data, configuration and branding details about the tenant

Get Tenant

GET https://3mpvy5eymh.execute-api.us-east-1.amazonaws.com/Production

This endpoint provides important tenant configuration and brand related information.

Query Parameters

Name	Type	Description
tenant_db	string	Send unique Tenant Db key to identify the tenant
api_key	string	Send the authorized token for the tenant.

200 Successfully retrieved Tenant. All potential Keys for the tenant: ['logo', 'logo_square', 'favicon_logo_square', 'logo_wide', 'segment_status', 'segment_key', 'company_name', 'brand_name', 'auto_apply_status_for_candidates', 'host_name', 'full_href', 'registered_address', 'facebook_page', 'google_plus', 'linkedin_page', 'instagram_page', 'snapchat_account', 'generic_support_from_email', 'location_display_pre_hire', 'location_display_on_ads', 'time_options_type', 'show_shifts_open_count_on_job', 'self_hire', 'gender_staff_status', 'brand_color_action', 'brand_swatches', 'brand_color_bg_dark', 'brand_color_bg_light', 'brand_color_primary_action', 'brand_color_secondary_action', 'login_page_bg_pic', 'signout_page_bg_pic', 'default_currency_three_code', 'default_timezone', 'default_currency_symbol', 'default_currency_multiple', 'authentication_page_image', 'interview_feature', 'custom_staff_terms_config', 'custom_staff_terms', 'custom_client_terms_config', 'custom_client_terms', 'show_client_data_on_ad', 'tenant_key_unique', 'freelancer_date_based_view', 'per_shift_button' ]

{
  "brand_color_primary_action": "#27ad60",
  "freelancer_date_based_view": "true",
  "segment_status": "true",
  "time_options_type": "5 minutes",
  "favicon_logo_square": "https://www.filepicker.io/api/file/example",
  "auto_apply_status_for_candidates": "true",
  "generic_support_from_email": "support@example",
  "location_display_pre_hire": "full_address",
  "login_page_bg_pic": "https://source.unsplash.com/featured/random",
  "company_name": "Wolf Lab Inc.",
  "signout_page_bg_pic": "https://source.unsplash.com/featured/random",
  "logo_wide": "https://www.filepicker.io/api/file/example",
  "show_shifts_open_count_on_job": "false",
  "segment_key": "xEO0kbBhif5yyhOzExamplee",
  "self_hire": "false",
  "host_name": "www.example.com",
  "gender_staff_status": "true",
  "brand_color_action": "#cb6bd3",
  "logo": "https://www.filepicker.io/api/file/example",
  "authentication_page_image": "https://www.filepicker.io/api/file/example",
  "interview_feature": "true",
  "custom_staff_terms_config": "false",
  "custom_staff_terms": "Html terms for staff when they are signing up",
  "brand_color_secondary_action": "#cb6bd3",
  "default_currency_symbol": "$",
  "full_href": "https://www.example.com",
  "default_currency_multiple": "100",
  "show_client_data_on_ad": "false",
  "location_display_on_ads": "full_address",
  "default_currency_three_code": "usd",
  "brand_color_bg_light": "#2c91de",
  "brand_color_bg_dark": "#2c91de",
  "brand_name": "Wolf Lab",
  "logo_square": "https://www.filepicker.io/api/file/example",
  "custom_client_terms_config": "false",
  "custom_client_terms": "html code with terms for clients",
  "terms_url": "www.example.com/privacy"
  "registered_address": "447 Broadway, New York, NY 100013",
  "default_timezone": "America/New_York",
  "brand_swatches": "#51A4E4,#0c7ed6,#065c9f,#5E7CE2,#4472CA"
}

404 Could not find a cake matching this query.

 { "statusCode": 401, "body": 'Authentication Failed' }