users

Resource: user

This link relationship returns a collection of users. You can paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last.

Collection Resource

user

Actions

GET View a list of users
POST Create a new user
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (5)

_embedded Object · Read-only

Contains fx:users[] — array of user resources

total_items String · Read-only

Total number of resources in this collection.

returned_items Number · Read-only

Number of resources returned in this page.

limit Number · Read-only

Maximum number of resources per page.

offset Number · Read-only

Number of resources skipped.

Link Relations (5)

self This Collection
first First Page of this Collection
prev Previous Page of this Collection
next Next Page of this Collection
last Last Page of this Collection
https://api.foxycart.com/users
Available via fx:users on store

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/users",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/users?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/users?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/users?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/users?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:users": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/users/456",
            "title": "This User"
          },
          "fx:attributes": {
            "href": "https://api.foxycart.com/users/123/attributes",
            "title": "Attributes for This User"
          },
          "fx:default_store": {
            "href": "https://api.foxycart.com/stores/456",
            "title": "Default Store for This User"
          },
          "fx:stores": {
            "href": "https://api.foxycart.com/users/123/stores",
            "title": "Stores for This User"
          },
          "fx:user_invitations": {
            "href": "https://api.foxycart.com/users/123/user_invitations",
            "title": "User Invitations for This User"
          },
          "fx:user_passkeys": {
            "href": "https://api.foxycart.com/users/123/passkeys",
            "title": "Passkeys for This User"
          }
        },
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@example.com",
        "phone": "555-555-5555",
        "affiliate_id": 0,
        "is_programmer": true,
        "is_front_end_developer": false,
        "is_designer": false,
        "is_merchant": true,
        "date_created": "2007-05-23T16:09:12-0700",
        "date_modified": "2013-07-10T22:37:49-0700"
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}