Lists Invites - Medusa

Request

None

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

Body

invites

array[object (Invite) {10}]

required

An array of invites

id

string

required

The invite's ID

Example:

invite_01G8TKE4XYCTHSCK2GDEP47RE1

user_email

string <email>

required

The email of the user being invited.

accepted

boolean

required

Whether the invite was accepted or not.

Default:

false

token

string

required

The token used to accept the invite.

expires_at

string <date-time>

required

The date the invite expires at.

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

deleted_at

string <date-time> | null

required

The date with timezone at which the resource was deleted.

role

enum<string> | enum<null>

required

The user's role. These roles don't change the privileges of the user.

Allowed values:

adminmemberdeveloper

Default:

member

metadata

object | null

required

An optional key-value map with additional details

Example:

{"car":"white"}

Example

{
  "invites": [
    {
      "id": "invite_01G8TKE4XYCTHSCK2GDEP47RE1",
      "user_email": "user@example.com",
      "accepted": false,
      "token": "string",
      "expires_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "role": "member",
      "metadata": {
        "car": "white"
      }
    }
  ]
}

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error