The Users API

On this Page

  1. Introduction
  2. The Request Format
  3. Sample Response
  4. The <User> Element

Other APIs

  1. API Introduction
  2. Forms GET
  3. Fields GET
  4. Entries GET / POST
  5. Users GET
  6. Reports GET
  7. Widgets GET
  8. Comments GET
  9. Web Hooks PUT / DELETE
  10. Login POST
  11. Examples
  12. The Wufoo REST Principles


Introduction

The Users API is used to gather details about the users you have defined through User Management.

See it in Action

If you are unsure how to get started with our API’s, please read our intro page for information on authenticating, sending and processing your request.

Request Format

This API accepts GET requests in the following format:

https://{subdomain}.wufoo.com/api/v3/users.{xml|json}[?pretty=true]

{subdomain}

This placeholder must be replaced with your subdomain.

{xml|json}

You must choose between xml or json

pretty=true

Pretty prints your output

Adds the node

Sample Response

Below is a sample response from a fictional call to the Users API.

<User>
    <User>timmy</User>
    <Email>timmy@wufoo.com</Email>
    <TimeZone>-5.00</TimeZone>
    <Company/>
    <IsAccountOwner>1</IsAccountOwner>
    <CreateForms>0</CreateForms>
    <CreateReports>0</CreateReports>
    <CreateThemes>0</CreateThemes>
    <AdminAccess>1</AdminAccess>
    <ApiKey>KUHU-ADUE-URDE-ARUE</ApiKey>
    <Hash>n7g3z1</Hash>
    <ImageUrlBig>https://wufoo.com/images/avatars/big/boy_1.png</ImageUrlBig>
    <ImageUrlSmall>https://wufoo.com/images/avatars/small/boy_1.png</ImageUrlSmall>
    <HttpsEnabled>1</HttpsEnabled>
</User>

The <User> Element

The <User> element lives inside the parent. One element exists for each user on your system. So, if you have 5 users in your account and you’re permitted to see them all, you’ll have 5 <User> elements in the return value from your API call.

Values for the <User> element are defined below.

User

Is the user name. This is the friendly name you chose when creating this user.

Email

The email address on file for this user.

Timezone

an offset from UTC.

Company

The company defined when this user was created.

IsAccountOwner

Binary value indicating a yes (1) or (0). If the user is an account owner the Create(Forms/Reports/Themes) and AdminAccess values are ignored, as an AccountOwner has full rights to the account.

CreateForms

Binary value indicating whether or not this user may create forms.

CreateReports

Binary value indicating whether or not this user may create reports.

CreateThemes

Binary value indicating whether or not this user may create themes.

AdminAccess

This is an all-inclusive access right. In other words, if a user has this permission, they may create forms/reports/themes and administer users.

ApiKey

The authentication token permitting the user to make requests against the system.

Hash

An unchanging value representing the user.

ImageUrlBig

A link to the user’s big image. Example Follows.

ImageUrlSmall

A link to the user’s big image. Example Follows.

HttpsEnabled

This value refers to whether or not https is enabled for the form link. An example will help here. Imagine your application redirects the user to one of her forms. If HttpsEnabled == 1, you may link to the https version. Conversely, if HttpsEnabled == 0, then you’d direct them to the http version. Quick Note: this does not apply to the way you call the API, only the way you display the form. An attempt to call the API without encryption (without the https prefix) will result in a 400 error without redirect.

Updated : October 21st, 2010