< Back to zoomrank.com

Retrieve all users

URL

https://api.zoomrank.com/users.xml

Supported formats

xml, json

Supported request methods

GET

Example 1

Retrieve all users either within your group or for your specific account (based on ZoomRank account setup).

https://api.zoomrank.com/users.xml

Example 2

Retrieve all users either within your group or for your specific account (based on ZoomRank account setup) with external ID "178261".

https://api.zoomrank.com/users.xml?external_id=EXTID1

Arguments

Argument Description Format
page The page of results to return. Defaults to page 1.
external_id The external ID assigned to the ZoomRank user. If this argument is provided, only users matching will be returned.

Response Codes

404 - No records found

Example Response

<users>
	<user id="1">
		<plan_id>1</plan_id>
		<external_id>EXTID1</external_id>
		<username>john@doe.com</username>
		<first_name>John</first_name>
		<last_name>Doe</last_name>
		<company>John Doe Inc.</company>
		<email>marketing@doe.com</email>
		<automatically_rank>true</automatically_rank>
		<rank_frequency>daily</rank_frequency>
		<rank_frequency_details/>
		<rank_email_frequency>daily</rank_email_frequency>
		<rank_email_recipient/>
		<allowed_keywords>25</allowed_keywords>
		<available_keywords>1</available_keywords>
	</user>
	<user id="2">
		<plan_id>1</plan_id>
		<external_id>EXTID2</external_id>
		<username>jane@doe.com</username>
		<first_name>Jane</first_name>
		<last_name>Doe</last_name>
		<company>John Doe Inc.</company>
		<email>marketing@doe.com</email>
		<automatically_rank>true</automatically_rank>
		<rank_frequency>daily</rank_frequency>
		<rank_frequency_details/>
		<rank_email_frequency>daily</rank_email_frequency>
		<rank_email_recipient/>
		<allowed_keywords>25</allowed_keywords>
		<available_keywords>20</available_keywords>
	</user>
</users>