Sign in

v1

latestOpenAPI 3.0.32026-08-068925782.3 MB
Domains

get/domains/{domain_pk}/users

Path parameters

domain_pkstring required

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

emailstring

Filter for: email

lookups: eq, ne, like, ilike, in, out

search: true

external_idstring

Filter for: external_id

lookups: eq, ne, like, ilike, null, in, out

search: true

idstring

Filter for: id

lookups: eq, ne, like, ilike, null, in, out

search: true

idp.idstring

Filter for: idp.id

lookups: eq, ne, like, ilike, null, in, out

namestring

Filter for: name

lookups: eq, ne, like, ilike, null, in, out

search: true

ordering: true

Response

idstring
namestring nullable
iconstring binary nullable
activestring
blocklistedboolean

Email notifications to the user disabled because of bounces. Unsetting this won't unblock the user, please remove the email address from Notifications Backoffice -> Blocklist instead.

emailstring email required
notificationsstring

Just for backward compatibility

announcementsboolean

Receive marketing news and announcements

region'aa' | 'aa_DJ' | 'aa_ER' | 'aa_ET' | 'ab' | 'ab_GE' | 'af' | 'af_NA' | 'af_ZA' | 'agq' | 'agq_CM' | 'ak' | 'ak_GH' | 'am' | 'am_ET' | 'an' | 'an_ES' | 'ann' | 'ann_NG' | 'apc' | 'apc_SY' | 'ar' | 'ar_001' | 'ar_AE' | 'ar_BH' | 'ar_DJ' | 'ar_DZ' | 'ar_EG' | 'ar_EH' | 'ar_ER' | 'ar_IL' | 'ar_IQ' | 'ar_JO' | 'ar_KM' | 'ar_KW' | 'ar_LB' | 'ar_LY' | 'ar_MA' | 'ar_MR' | 'ar_OM' | 'ar_PS' | 'ar_QA' | 'ar_SA' | 'ar_SD' | 'ar_SO' | 'ar_SS' | 'ar_SY' | 'ar_TD' | 'ar_TN' | 'ar_YE' | 'arn' | 'arn_CL' | 'as' | 'as_IN' | 'asa' | 'asa_TZ' | 'ast' | 'ast_ES' | 'az' | 'az_Arab' | 'az_Arab_IQ' | 'az_Arab_IR' | 'az_Arab_TR' | 'az_Cyrl' | 'az_Cyrl_AZ' | 'az_Latn' | 'az_Latn_AZ' | 'ba' | 'ba_RU' | 'bal' | 'bal_Arab' | 'bal_Arab_PK' | 'bal_Latn' | 'bal_Latn_PK' | 'bas' | 'bas_CM' | 'be' | 'be_BY' | 'be_TARASK' | 'bem' | 'bem_ZM' | 'bew' | 'bew_ID' | 'bez' | 'bez_TZ' | 'bg' | 'bg_BG' | 'bgc' | 'bgc_IN' | 'bgn' | 'bgn_AE' | 'bgn_AF' | 'bgn_IR' | 'bgn_OM' | 'bgn_PK' | 'bho' | 'bho_IN' | 'blo' | 'blo_BJ' | 'blt' | 'blt_VN' | 'bm' | 'bm_ML' | 'bm_Nkoo' | 'bm_Nkoo_ML' | 'bn' | 'bn_BD' | 'bn_IN' | 'bo' | 'bo_CN' | 'bo_IN' | 'br' | 'br_FR' | 'brx' | 'brx_IN' | 'bs' | 'bs_Cyrl' | 'bs_Cyrl_BA' | 'bs_Latn' | 'bs_Latn_BA' | 'bss' | 'bss_CM' | 'byn' | 'byn_ER' | 'ca' | 'ca_AD' | 'ca_ES' | 'ca_ES_VALENCIA' | 'ca_FR' | 'ca_IT' | 'cad' | 'cad_US' | 'cch' | 'cch_NG' | 'ccp' | 'ccp_BD' | 'ccp_IN' | 'ce' | 'ce_RU' | 'ceb' | 'ceb_PH' | 'cgg' | 'cgg_UG' | 'cho' | 'cho_US' | 'chr' | 'chr_US' | 'cic' | 'cic_US' | 'ckb' | 'ckb_IQ' | 'ckb_IR' | 'co' | 'co_FR' | 'cop' | 'cop_EG' | 'cs' | 'cs_CZ' | 'csw' | 'csw_CA' | 'cu' | 'cu_RU' | 'cv' | 'cv_RU' | 'cy' | 'cy_GB' | 'da' | 'da_DK' | 'da_GL' | 'dav' | 'dav_KE' | 'de' | 'de_AT' | 'de_BE' | 'de_CH' | 'de_DE' | 'de_IT' | 'de_LI' | 'de_LU' | 'dje' | 'dje_NE' | 'doi' | 'doi_IN' | 'dsb' | 'dsb_DE' | 'dua' | 'dua_CM' | 'dv' | 'dv_MV' | 'dyo' | 'dyo_SN' | 'dz' | 'dz_BT' | 'ebu' | 'ebu_KE' | 'ee' | 'ee_GH' | 'ee_TG' | 'el' | 'el_CY' | 'el_GR' | 'el_POLYTON' | 'en' | 'en_001' | 'en_150' | 'en_AE' | 'en_AG' | 'en_AI' | 'en_AS' | 'en_AT' | 'en_AU' | 'en_BB' | 'en_BE' | 'en_BI' | 'en_BM' | 'en_BS' | 'en_BW' | 'en_BZ' | 'en_CA' | 'en_CC' | 'en_CH' | 'en_CK' | 'en_CM' | 'en_CX' | 'en_CY' | 'en_CZ' | 'en_DE' | 'en_DG' | 'en_DK' | 'en_DM' | 'en_Dsrt' | 'en_Dsrt_US' | 'en_ER' | 'en_ES' | 'en_FI' | 'en_FJ' | 'en_FK' | 'en_FM' | 'en_FR' | 'en_GB' | 'en_GD' | 'en_GG' | 'en_GH' | 'en_GI' | 'en_GM' | 'en_GS' | 'en_GU' | 'en_GY' | 'en_HK' | 'en_HU' | 'en_ID' | 'en_IE' | 'en_IL' | 'en_IM' | 'en_IN' | 'en_IO' | 'en_IT' | 'en_JE' | 'en_JM' | 'en_KE' | 'en_KI' | 'en_KN' | 'en_KY' | 'en_LC' | 'en_LR' | 'en_LS' | 'en_MG' | 'en_MH' | 'en_MO' | 'en_MP' | 'en_MS' | 'en_MT' | 'en_MU' | 'en_MV' | 'en_MW' | 'en_MY' | 'en_NA' | 'en_NF' | 'en_NG' | 'en_NL' | 'en_NO' | 'en_NR' | 'en_NU' | 'en_NZ' | 'en_PG' | 'en_PH' | 'en_PK' | 'en_PL' | 'en_PN' | 'en_PR' | 'en_PT' | 'en_PW' | 'en_RO' | 'en_RW' | 'en_SB' | 'en_SC' | 'en_SD' | 'en_SE' | 'en_SG' | 'en_SH' | 'en_SI' | 'en_SK' | 'en_SL' | 'en_SS' | 'en_SX' | 'en_SZ' | 'en_Shaw' | 'en_Shaw_GB' | 'en_TC' | 'en_TK' | 'en_TO' | 'en_TT' | 'en_TV' | 'en_TZ' | 'en_UG' | 'en_UM' | 'en_US' | 'en_US_POSIX' | 'en_VC' | 'en_VG' | 'en_VI' | 'en_VU' | 'en_WS' | 'en_ZA' | 'en_ZM' | 'en_ZW' | 'eo' | 'eo_001' | 'es' | 'es_419' | 'es_AR' | 'es_BO' | 'es_BR' | 'es_BZ' | 'es_CL' | 'es_CO' | 'es_CR' | 'es_CU' | 'es_DO' | 'es_EA' | 'es_EC' | 'es_ES' | 'es_GQ' | 'es_GT' | 'es_HN' | 'es_IC' | 'es_MX' | 'es_NI' | 'es_PA' | 'es_PE' | 'es_PH' | 'es_PR' | 'es_PY' | 'es_SV' | 'es_US' | 'es_UY' | 'es_VE' | 'et' | 'et_EE' | 'eu' | 'eu_ES' | 'ewo' | 'ewo_CM' | 'fa' | 'fa_AF' | 'fa_IR' | 'ff' | 'ff_Adlm' | 'ff_Adlm_BF' | 'ff_Adlm_CM' | 'ff_Adlm_GH' | 'ff_Adlm_GM' | 'ff_Adlm_GN' | 'ff_Adlm_GW' | 'ff_Adlm_LR' | 'ff_Adlm_MR' | 'ff_Adlm_NE' | 'ff_Adlm_NG' | 'ff_Adlm_SL' | 'ff_Adlm_SN' | 'ff_Latn' | 'ff_Latn_BF' | 'ff_Latn_CM' | 'ff_Latn_GH' | 'ff_Latn_GM' | 'ff_Latn_GN' | 'ff_Latn_GW' | 'ff_Latn_LR' | 'ff_Latn_MR' | 'ff_Latn_NE' | 'ff_Latn_NG' | 'ff_Latn_SL' | 'ff_Latn_SN' | 'fi' | 'fi_FI' | 'fil' | 'fil_PH' | 'fo' | 'fo_DK' | 'fo_FO' | 'fr' | 'fr_BE' | 'fr_BF' | 'fr_BI' | 'fr_BJ' | 'fr_BL' | 'fr_CA' | 'fr_CD' | 'fr_CF' | 'fr_CG' | 'fr_CH' | 'fr_CI' | 'fr_CM' | 'fr_DJ' | 'fr_DZ' | 'fr_FR' | 'fr_GA' | 'fr_GF' | 'fr_GN' | 'fr_GP' | 'fr_GQ' | 'fr_HT' | 'fr_KM' | 'fr_LU' | 'fr_MA' | 'fr_MC' | 'fr_MF' | 'fr_MG' | 'fr_ML' | 'fr_MQ' | 'fr_MR' | 'fr_MU' | 'fr_NC' | 'fr_NE' | 'fr_PF' | 'fr_PM' | 'fr_RE' | 'fr_RW' | 'fr_SC' | 'fr_SN' | 'fr_SY' | 'fr_TD' | 'fr_TG' | 'fr_TN' | 'fr_VU' | 'fr_WF' | 'fr_YT' | 'frr' | 'frr_DE' | 'fur' | 'fur_IT' | 'fy' | 'fy_NL' | 'ga' | 'ga_GB' | 'ga_IE' | 'gaa' | 'gaa_GH' | 'gd' | 'gd_GB' | 'gez' | 'gez_ER' | 'gez_ET' | 'gl' | 'gl_ES' | 'gn' | 'gn_PY' | 'gsw' | 'gsw_CH' | 'gsw_FR' | 'gsw_LI' | 'gu' | 'gu_IN' | 'guz' | 'guz_KE' | 'gv' | 'gv_IM' | 'ha' | 'ha_Arab' | 'ha_Arab_NG' | 'ha_Arab_SD' | 'ha_GH' | 'ha_NE' | 'ha_NG' | 'haw' | 'haw_US' | 'he' | 'he_IL' | 'hi' | 'hi_IN' | 'hi_Latn' | 'hi_Latn_IN' | 'hnj' | 'hnj_Hmnp' | 'hnj_Hmnp_US' | 'hr' | 'hr_BA' | 'hr_HR' | 'hsb' | 'hsb_DE' | 'ht' | 'ht_HT' | 'hu' | 'hu_HU' | 'hy' | 'hy_AM' | 'ia' | 'ia_001' | 'id' | 'id_ID' | 'ie' | 'ie_EE' | 'ig' | 'ig_NG' | 'ii' | 'ii_CN' | 'io' | 'io_001' | 'is' | 'is_IS' | 'it' | 'it_CH' | 'it_IT' | 'it_SM' | 'it_VA' | 'iu' | 'iu_CA' | 'iu_Latn' | 'iu_Latn_CA' | 'ja' | 'ja_JP' | 'jbo' | 'jbo_001' | 'jgo' | 'jgo_CM' | 'jmc' | 'jmc_TZ' | 'jv' | 'jv_ID' | 'ka' | 'ka_GE' | 'kaa' | 'kaa_Cyrl' | 'kaa_Cyrl_UZ' | 'kaa_Latn' | 'kaa_Latn_UZ' | 'kab' | 'kab_DZ' | 'kaj' | 'kaj_NG' | 'kam' | 'kam_KE' | 'kcg' | 'kcg_NG' | 'kde' | 'kde_TZ' | 'kea' | 'kea_CV' | 'ken' | 'ken_CM' | 'kgp' | 'kgp_BR' | 'khq' | 'khq_ML' | 'ki' | 'ki_KE' | 'kk' | 'kk_Arab' | 'kk_Arab_CN' | 'kk_Cyrl' | 'kk_Cyrl_KZ' | 'kk_KZ' | 'kkj' | 'kkj_CM' | 'kl' | 'kl_GL' | 'kln' | 'kln_KE' | 'km' | 'km_KH' | 'kn' | 'kn_IN' | 'ko' | 'ko_CN' | 'ko_KP' | 'ko_KR' | 'kok' | 'kok_Deva' | 'kok_Deva_IN' | 'kok_Latn' | 'kok_Latn_IN' | 'kpe' | 'kpe_GN' | 'kpe_LR' | 'ks' | 'ks_Arab' | 'ks_Arab_IN' | 'ks_Deva' | 'ks_Deva_IN' | 'ksb' | 'ksb_TZ' | 'ksf' | 'ksf_CM' | 'ksh' | 'ksh_DE' | 'ku' | 'ku_TR' | 'kw' | 'kw_GB' | 'kxv' | 'kxv_Deva' | 'kxv_Deva_IN' | 'kxv_Latn' | 'kxv_Latn_IN' | 'kxv_Orya' | 'kxv_Orya_IN' | 'kxv_Telu' | 'kxv_Telu_IN' | 'ky' | 'ky_KG' | 'la' | 'la_VA' | 'lag' | 'lag_TZ' | 'lb' | 'lb_LU' | 'lg' | 'lg_UG' | 'lij' | 'lij_IT' | 'lkt' | 'lkt_US' | 'lld' | 'lld_IT' | 'lmo' | 'lmo_IT' | 'ln' | 'ln_AO' | 'ln_CD' | 'ln_CF' | 'ln_CG' | 'lo' | 'lo_LA' | 'lrc' | 'lrc_IQ' | 'lrc_IR' | 'lt' | 'lt_LT' | 'ltg' | 'ltg_LV' | 'lu' | 'lu_CD' | 'luo' | 'luo_KE' | 'luy' | 'luy_KE' | 'lv' | 'lv_LV' | 'mai' | 'mai_IN' | 'mas' | 'mas_KE' | 'mas_TZ' | 'mdf' | 'mdf_RU' | 'mer' | 'mer_KE' | 'mfe' | 'mfe_MU' | 'mg' | 'mg_MG' | 'mgh' | 'mgh_MZ' | 'mgo' | 'mgo_CM' | 'mhn' | 'mhn_IT' | 'mi' | 'mi_NZ' | 'mic' | 'mic_CA' | 'mk' | 'mk_MK' | 'ml' | 'ml_IN' | 'mn' | 'mn_MN' | 'mn_Mong' | 'mn_Mong_CN' | 'mn_Mong_MN' | 'mni' | 'mni_Beng' | 'mni_Beng_IN' | 'mni_Mtei' | 'mni_Mtei_IN' | 'moh' | 'moh_CA' | 'mr' | 'mr_IN' | 'ms' | 'ms_Arab' | 'ms_Arab_BN' | 'ms_Arab_MY' | 'ms_BN' | 'ms_ID' | 'ms_MY' | 'ms_SG' | 'mt' | 'mt_MT' | 'mua' | 'mua_CM' | 'mus' | 'mus_US' | 'my' | 'my_MM' | 'myv' | 'myv_RU' | 'mzn' | 'mzn_IR' | 'naq' | 'naq_NA' | 'nb' | 'nb_NO' | 'nb_SJ' | 'nd' | 'nd_ZW' | 'nds' | 'nds_DE' | 'nds_NL' | 'ne' | 'ne_IN' | 'ne_NP' | 'nl' | 'nl_AW' | 'nl_BE' | 'nl_BQ' | 'nl_CW' | 'nl_NL' | 'nl_SR' | 'nl_SX' | 'nmg' | 'nmg_CM' | 'nn' | 'nn_NO' | 'nnh' | 'nnh_CM' | 'no' | 'nqo' | 'nqo_GN' | 'nr' | 'nr_ZA' | 'nso' | 'nso_ZA' | 'nus' | 'nus_SS' | 'nv' | 'nv_US' | 'ny' | 'ny_MW' | 'nyn' | 'nyn_UG' | 'oc' | 'oc_ES' | 'oc_FR' | 'om' | 'om_ET' | 'om_KE' | 'or' | 'or_IN' | 'os' | 'os_GE' | 'os_RU' | 'osa' | 'osa_US' | 'pa' | 'pa_Arab' | 'pa_Arab_PK' | 'pa_Guru' | 'pa_Guru_IN' | 'pap' | 'pap_AW' | 'pap_CW' | 'pcm' | 'pcm_NG' | 'pis' | 'pis_SB' | 'pl' | 'pl_PL' | 'prg' | 'prg_PL' | 'ps' | 'ps_AF' | 'ps_PK' | 'pt' | 'pt_AO' | 'pt_BR' | 'pt_CH' | 'pt_CV' | 'pt_GQ' | 'pt_GW' | 'pt_LU' | 'pt_MO' | 'pt_MZ' | 'pt_PT' | 'pt_ST' | 'pt_TL' | 'qu' | 'qu_BO' | 'qu_EC' | 'qu_PE' | 'quc' | 'quc_GT' | 'raj' | 'raj_IN' | 'rhg' | 'rhg_Rohg' | 'rhg_Rohg_BD' | 'rhg_Rohg_MM' | 'rif' | 'rif_MA' | 'rm' | 'rm_CH' | 'rn' | 'rn_BI' | 'ro' | 'ro_MD' | 'ro_RO' | 'rof' | 'rof_TZ' | 'ru' | 'ru_BY' | 'ru_KG' | 'ru_KZ' | 'ru_MD' | 'ru_RU' | 'ru_UA' | 'rw' | 'rw_RW' | 'rwk' | 'rwk_TZ' | 'sa' | 'sa_IN' | 'sah' | 'sah_RU' | 'saq' | 'saq_KE' | 'sat' | 'sat_Deva' | 'sat_Deva_IN' | 'sat_Olck' | 'sat_Olck_IN' | 'sbp' | 'sbp_TZ' | 'sc' | 'sc_IT' | 'scn' | 'scn_IT' | 'sd' | 'sd_Arab' | 'sd_Arab_PK' | 'sd_Deva' | 'sd_Deva_IN' | 'sdh' | 'sdh_IQ' | 'sdh_IR' | 'se' | 'se_FI' | 'se_NO' | 'se_SE' | 'seh' | 'seh_MZ' | 'ses' | 'ses_ML' | 'sg' | 'sg_CF' | 'shi' | 'shi_Latn' | 'shi_Latn_MA' | 'shi_Tfng' | 'shi_Tfng_MA' | 'shn' | 'shn_MM' | 'shn_TH' | 'si' | 'si_LK' | 'sid' | 'sid_ET' | 'sk' | 'sk_SK' | 'skr' | 'skr_PK' | 'sl' | 'sl_SI' | 'sma' | 'sma_NO' | 'sma_SE' | 'smj' | 'smj_NO' | 'smj_SE' | 'smn' | 'smn_FI' | 'sms' | 'sms_FI' | 'sn' | 'sn_ZW' | 'so' | 'so_DJ' | 'so_ET' | 'so_KE' | 'so_SO' | 'sq' | 'sq_AL' | 'sq_MK' | 'sq_XK' | 'sr' | 'sr_Cyrl' | 'sr_Cyrl_BA' | 'sr_Cyrl_ME' | 'sr_Cyrl_RS' | 'sr_Cyrl_XK' | 'sr_Latn' | 'sr_Latn_BA' | 'sr_Latn_ME' | 'sr_Latn_RS' | 'sr_Latn_XK' | 'ss' | 'ss_SZ' | 'ss_ZA' | 'ssy' | 'ssy_ER' | 'st' | 'st_LS' | 'st_ZA' | 'su' | 'su_Latn' | 'su_Latn_ID' | 'sv' | 'sv_AX' | 'sv_FI' | 'sv_SE' | 'sw' | 'sw_CD' | 'sw_KE' | 'sw_TZ' | 'sw_UG' | 'syr' | 'syr_IQ' | 'syr_SY' | 'szl' | 'szl_PL' | 'ta' | 'ta_IN' | 'ta_LK' | 'ta_MY' | 'ta_SG' | 'te' | 'te_IN' | 'teo' | 'teo_KE' | 'teo_UG' | 'tg' | 'tg_TJ' | 'th' | 'th_TH' | 'ti' | 'ti_ER' | 'ti_ET' | 'tig' | 'tig_ER' | 'tk' | 'tk_TM' | 'tn' | 'tn_BW' | 'tn_ZA' | 'to' | 'to_TO' | 'tok' | 'tok_001' | 'tpi' | 'tpi_PG' | 'tr' | 'tr_CY' | 'tr_TR' | 'trv' | 'trv_TW' | 'trw' | 'trw_PK' | 'ts' | 'ts_ZA' | 'tt' | 'tt_RU' | 'twq' | 'twq_NE' | 'tyv' | 'tyv_RU' | 'tzm' | 'tzm_MA' | 'ug' | 'ug_CN' | 'uk' | 'uk_UA' | 'ur' | 'ur_IN' | 'ur_PK' | 'uz' | 'uz_Arab' | 'uz_Arab_AF' | 'uz_Cyrl' | 'uz_Cyrl_UZ' | 'uz_Latn' | 'uz_Latn_UZ' | 'vai' | 'vai_Latn' | 'vai_Latn_LR' | 'vai_Vaii' | 'vai_Vaii_LR' | 've' | 've_ZA' | 'vec' | 'vec_IT' | 'vi' | 'vi_VN' | 'vmw' | 'vmw_MZ' | 'vo' | 'vo_001' | 'vun' | 'vun_TZ' | 'wa' | 'wa_BE' | 'wae' | 'wae_CH' | 'wal' | 'wal_ET' | 'wbp' | 'wbp_AU' | 'wo' | 'wo_SN' | 'xh' | 'xh_ZA' | 'xnr' | 'xnr_IN' | 'xog' | 'xog_UG' | 'yav' | 'yav_CM' | 'yi' | 'yi_UA' | 'yo' | 'yo_BJ' | 'yo_NG' | 'yrl' | 'yrl_BR' | 'yrl_CO' | 'yrl_VE' | 'yue' | 'yue_Hans' | 'yue_Hans_CN' | 'yue_Hant' | 'yue_Hant_CN' | 'yue_Hant_HK' | 'yue_Hant_MO' | 'za' | 'za_CN' | 'zgh' | 'zgh_MA' | 'zh' | 'zh_Hans' | 'zh_Hans_CN' | 'zh_Hans_HK' | 'zh_Hans_MO' | 'zh_Hans_MY' | 'zh_Hans_SG' | 'zh_Hant' | 'zh_Hant_HK' | 'zh_Hant_MO' | 'zh_Hant_MY' | 'zh_Hant_TW' | 'zh_Latn' | 'zh_Latn_CN' | 'zu' | 'zu_ZA'
timeformatstring
timezonestring required
titlestring nullable
external_idstring nullable