Spongecell API Documentation: Reference

Spongecell API Documentation: Reference - Users

Lets you manage your authorized Spongecell user account(s), as well as create a new user account.

If you have enabled community builder support, then you will be able to create, view, update, and delete users from your community.

Otherwise, you will only be able to view and modify your own user account.

Please log in (above) to see more examples.

Show a new user (which shows the fields that can be passed in the create): /api/users/new.

The following actions are supported for this resource:

index	GET	/api/users	Returns a list of your community users. If email parameter is specified, returns only the community user matching that email address..
email	STRING	Email address

show	GET	/api/users/1	Returns the user id of the logged in user.
start_time	DATETIME	Only include events on or after specified date and time
max_results	INTEGER	The maximum number of results to return. If not specified, default is 50.

new	GET	/api/users/new	Construct a new resource (do NOT save it), returning the editable fields with default values.

edit	GET	/api/users/1/edit	Return the editable fields for the specified resource.

create	POST	/api/users	Create the session, i.e. log user in.
email	STRING	Email address
password	STRING	Password for authentication
user_name	STRING	User name
first_name	STRING	First name
last_name	STRING	Last name
mobile_number	STRING	Mobile phone number
mobile_type	STRING	Mobile phone type

update	PUT	/api/users/1	Update the specified resource with the data in the POST request.
email	STRING	Email address
password	STRING	Password for authentication
user_name	STRING	User name
first_name	STRING	First name
last_name	STRING	Last name
mobile_number	STRING	Mobile phone number
mobile_type	STRING	Mobile phone type

destroy	DELETE	/api/users/1	Destroys the session, i.e. log user out.

verify_email_address	PUT	/api/users/1/verify_email_address	Sends out email address verification message for the specified user.