user_invitations

Resource: user_invitation

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

Required Scopes

Full user_full_access
Read users_read
Write users_write

Collection Resource

user_invitation

Actions

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

Properties (5)

_embedded Object · Read-only

Contains fx:user_invitations[] — array of user_invitation 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/{user_id}/user_invitations
Available via fx:user_invitations on store·fx:user_invitations on user

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/user_invitations",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/user_invitations?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/user_invitations?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/user_invitations?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/user_invitations?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:user_invitations": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/user_invitations/456",
            "title": "This User Invitation"
          },
          "fx:store": {
            "href": "https://api.foxycart.com/stores/456",
            "title": "This Store"
          },
          "fx:resend": {
            "href": "https://api.foxycart.com/resend",
            "title": "Resend the email for this invitation"
          },
          "fx:user": {
            "href": "https://api.foxycart.com/users/456",
            "title": "This User"
          }
        },
        "store_url": "http://www.example.com/",
        "store_name": "Example Store",
        "store_email": "john@example.com",
        "store_domain": "example",
        "first_name": "Mary",
        "last_name": "Smith",
        "email": "mary@example.com",
        "status": "sent",
        "date_created": "2022-12-01T10:07:05-0800",
        "date_modified": "2022-12-01T10:07:05-0800"
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}