> For the complete documentation index, see [llms.txt](https://docs.toomuchmedia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.toomuchmedia.com/api/api-endpoints/affiliate/api-affiliate-search.md).

# /api/affiliate/search

## GET /api/affiliate/search

> Search affiliates

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/affiliate/search"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"get_affiliate_search":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"paths":{"/api/affiliate/search":{"get":{"description":"Search affiliates","tags":["/api/affiliate/search"],"parameters":[{"name":"as_array","in":"query","schema":{"type":"string"},"required":false},{"name":"count","in":"query","schema":{"type":"integer"},"required":false},{"name":"end","in":"query","schema":{},"required":false},{"name":"orderby","in":"query","schema":{},"required":false},{"name":"output_format","in":"query","schema":{},"required":false},{"name":"return_payvia_info","in":"query","schema":{},"required":false},{"name":"return_referred_info","in":"query","schema":{},"required":false},{"name":"return_group_enabled","in":"query","schema":{"type":"integer"},"required":false},{"name":"return_payout_period_enabled","in":"query","schema":{"type":"integer"},"required":false},{"name":"return_program_enabled","in":"query","schema":{"type":"integer"},"required":false},{"name":"return_referring_info","in":"query","schema":{},"required":false},{"name":"return_w9","in":"query","schema":{"type":"string"},"required":false},{"name":"start","in":"query","schema":{"type":"integer"},"required":false},{"name":"widget","in":"query","schema":{"default":0,"type":"string"},"required":false},{"name":"download","in":"query","schema":{"default":0,"type":"string"},"required":false},{"name":"address","in":"query","schema":{"type":"string"},"required":false},{"name":"address_compare","in":"query","schema":{"default":"=","type":"string"},"required":false},{"name":"city","in":"query","schema":{"type":"string"},"required":false},{"name":"city_compare","in":"query","schema":{"default":"=","type":"string"},"required":false},{"name":"company","in":"query","schema":{"type":"string"},"required":false},{"name":"company_compare","in":"query","schema":{"default":"=","type":"string"},"required":false},{"name":"country","in":"query","schema":{"type":"string"},"required":false},{"name":"country_compare","in":"query","schema":{"default":"=","type":"string"},"required":false},{"name":"deleted","in":"query","schema":{"type":"string"},"required":false},{"name":"email_compare","in":"query","schema":{"default":"=","type":"string"},"required":false},{"name":"email","in":"query","schema":{"type":"string"},"required":false},{"name":"firstname_compare","in":"query","schema":{"default":"=","type":"string"},"required":false},{"name":"firstname","in":"query","schema":{"type":"string"},"required":false},{"name":"groupid","in":"query","schema":{"type":"integer"},"required":false},{"name":"groupid_compare","in":"query","schema":{"default":"=","type":"string"},"required":false},{"name":"group_disabled","in":"query","schema":{"type":"integer"},"required":false},{"name":"group_enabled","in":"query","schema":{"type":"integer"},"required":false},{"name":"inhouse","in":"query","schema":{"type":"string"},"required":false},{"name":"join_count","in":"query","schema":{},"required":false},{"name":"join_date","in":"query","schema":{},"required":false},{"name":"join_hits","in":"query","schema":{},"required":false},{"name":"join_ip","in":"query","schema":{},"required":false},{"name":"join_range","in":"query","schema":{},"required":false},{"name":"join_submits","in":"query","schema":{},"required":false},{"name":"lastname_compare","in":"query","schema":{"default":"=","type":"string"},"required":false},{"name":"lastname","in":"query","schema":{"type":"string"},"required":false},{"name":"login_date","in":"query","schema":{},"required":false},{"name":"loginid_compare","in":"query","schema":{"default":"=","type":"string"},"required":false},{"name":"loginid","in":"query","schema":{"type":"integer"},"required":false},{"name":"login_ip","in":"query","schema":{},"required":false},{"name":"login_range","in":"query","schema":{},"required":false},{"name":"min_pay","in":"query","schema":{},"required":false},{"name":"name","in":"query","schema":{"type":"string"},"required":false},{"name":"name_compare","in":"query","schema":{"default":"=","type":"string"},"required":false},{"name":"natscode_compare","in":"query","schema":{"default":"=","type":"string"},"required":false},{"name":"natscode","in":"query","schema":{"type":"string"},"required":false},{"name":"pay_range","in":"query","schema":{},"required":false},{"name":"payvia_details","in":"query","schema":{},"required":false},{"name":"payvia_type_id","in":"query","schema":{},"required":false},{"name":"payout_period_disabled","in":"query","schema":{"type":"integer"},"required":false},{"name":"payout_period_enabled","in":"query","schema":{"type":"integer"},"required":false},{"name":"program_disabled","in":"query","schema":{"type":"integer"},"required":false},{"name":"program_enabled","in":"query","schema":{"type":"integer"},"required":false},{"name":"ratio","in":"query","schema":{},"required":false},{"name":"raw_hits","in":"query","schema":{},"required":false},{"name":"rebill_count","in":"query","schema":{},"required":false},{"name":"refid","in":"query","schema":{},"required":false},{"name":"ref","in":"query","schema":{},"required":false},{"name":"refund_count","in":"query","schema":{},"required":false},{"name":"sales_rep","in":"query","schema":{},"required":false},{"name":"search_ref","in":"query","schema":{},"required":false},{"name":"teams","in":"query","schema":{"type":"string"},"required":false},{"name":"telegram","in":"query","schema":{"type":"string"},"required":false},{"name":"gchat","in":"query","schema":{"type":"string"},"required":false},{"name":"state_compare","in":"query","schema":{"default":"=","type":"string"},"required":false},{"name":"state","in":"query","schema":{"type":"string"},"required":false},{"name":"stats_end","in":"query","schema":{},"required":false},{"name":"stats_period","in":"query","schema":{},"required":false},{"name":"stats_start","in":"query","schema":{},"required":false},{"name":"status","in":"query","schema":{"type":"integer"},"required":false},{"name":"status_compare","in":"query","schema":{"default":"=","type":"string"},"required":false},{"name":"text_search","in":"query","schema":{},"required":false},{"name":"total_earned","in":"query","schema":{},"required":false},{"name":"total","in":"query","schema":{},"required":false},{"name":"type","in":"query","schema":{"type":"integer"},"required":false},{"name":"unq_hits","in":"query","schema":{},"required":false},{"name":"url","in":"query","schema":{},"required":false},{"name":"username_compare","in":"query","schema":{"default":"like","type":"string"},"required":false},{"name":"username","in":"query","schema":{"type":"string"},"required":false},{"name":"zip_code_compare","in":"query","schema":{"default":"=","type":"string"},"required":false},{"name":"zip_code","in":"query","schema":{"type":"string"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/get_affiliate_search"}},"application/json":{"schema":{"$ref":"#/components/schemas/get_affiliate_search"}},"application/xml":{"schema":{"$ref":"#/components/schemas/get_affiliate_search"}}}}}}}}}
```