Invites

Invites Documentation

Invite [LIST]

Invite [LIST]

Request

Endpoint

GET /api/v2/organizations/8646b67b-9a28-4de7-bd0e-27adacc99e45/invites
Content-Type: application/vnd.api+json

Body

Parameters

Filters

invite_user_as

Type string

Description Filter by type of invite; Accepts "admin"

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": [
    {
      "id": "0747f504-5188-45a7-9763-6e584a852fc9",
      "type": "organization_invites",
      "attributes": {
        "accepted_at": "-4712-01-01T00:00:00Z",
        "code": "9d6cb999fd8b85dc71994bcec57807444e482f63f8dbdd59d7e4740c90d69ea2",
        "created_at": "2021-11-23T14:38:03Z",
        "invite_user_as": "admin",
        "recipient_email": "[email protected]",
        "updated_at": "2021-11-23T14:38:03Z",
        "updated_in_db_at": "2021-11-23T14:38:03Z"
      },
      "relationships": {
        "accepted_by_user": {
          "data": null
        },
        "cancelled_by_user": {
          "data": null
        },
        "invited_by_user": {
          "data": {
            "id": "5b90d024-ffbd-496b-a610-ba63ccd20e3c",
            "type": "users"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Invite]

Description An array of Invites

Invite [POST]

Invite [POST]

Request

Endpoint

POST /api/v2/organizations/95af4f66-ea19-4a3b-8612-d835ca8c64f8/invites
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "organization_invites",
    "attributes": {
      "invite_user_as": "admin",
      "recipient_email": "[email protected]",
      "updated_in_db_at": "2021-11-23 14:38:02 UTC"
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

Required No

invite_user_as

Type string

Description What to type of association to create if user accepts invite; Accepts "admin"

Required No

recipient_email

Type string

Description Recipient Email

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

Body

{
  "data": {
    "id": "570bd313-3776-441c-921f-f2d6cee5de05",
    "type": "organization_invites",
    "attributes": {
      "accepted_at": null,
      "code": "d3f616aba20e79561a136ec5456d65adbc4054b5ebd075a6696f8ee334ddfd3c",
      "created_at": "2021-11-23T14:38:02Z",
      "invite_user_as": "admin",
      "recipient_email": "[email protected]",
      "updated_at": "2021-11-23T14:38:02Z",
      "updated_in_db_at": "2021-11-23T14:38:02Z"
    },
    "relationships": {
      "accepted_by_user": {
        "data": null
      },
      "cancelled_by_user": {
        "data": null
      },
      "invited_by_user": {
        "data": {
          "id": "a7875287-825a-48ad-8e87-c2df568b374b",
          "type": "users"
        }
      }
    }
  }
}

Fields

Attributes

accepted_at

Type string

Description Accepted At

code

Type string

Description Code

created_at

Type date

Description The timestamp of when this resource was created

invite_user_as

Type string

Description What to type of association to create if user accepts invite; Accepts "admin"

recipient_email

Type string

Description Recipient Email

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

accepted_by_user.data

Type User

Description user that accepted the invite

cancelled_by_user.data

Type User

Description user that cancelled the invite

invited_by_user.data

Type User

Description user that created the invite

Invite [GET]

Invite [GET]

Request

Endpoint

GET /api/v2/organizations/b9a1ac8f-e418-4af6-8d62-015899ae3240/invites/f7b9c8fb-d48e-480c-9e17-4b4b1a4495aa
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "f7b9c8fb-d48e-480c-9e17-4b4b1a4495aa",
    "type": "organization_invites",
    "attributes": {
      "accepted_at": "-4712-01-01T00:00:00Z",
      "code": "1b2151eabfa355f23c2876a6ff73bfbbb3b3b018114d6ac0effd9d87b251213b",
      "created_at": "2021-11-23T14:38:01Z",
      "invite_user_as": "admin",
      "recipient_email": "[email protected]",
      "updated_at": "2021-11-23T14:38:01Z",
      "updated_in_db_at": "2021-11-23T14:38:01Z"
    },
    "relationships": {
      "accepted_by_user": {
        "data": null
      },
      "cancelled_by_user": {
        "data": null
      },
      "invited_by_user": {
        "data": {
          "id": "3e4ca44f-92f8-452b-9369-1db96978d1e6",
          "type": "users"
        }
      }
    }
  }
}

Fields

Attributes

accepted_at

Type string

Description Accepted At

code

Type string

Description Code

created_at

Type date

Description The timestamp of when this resource was created

invite_user_as

Type string

Description What to type of association to create if user accepts invite; Accepts "admin"

recipient_email

Type string

Description Recipient Email

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

accepted_by_user.data

Type User

Description user that accepted the invite

cancelled_by_user.data

Type User

Description user that cancelled the invite

invited_by_user.data

Type User

Description user that created the invite

Invite [DELETE]

Invite [DELETE]

Request

Endpoint

DELETE /api/v2/organizations/d5ad0a83-eb97-4293-b593-de6e74190873/invites/84b7b330-0e3b-440f-9c7e-dc399d9089e0
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body

Invite [ACCEPT]

Invite [ACCEPT]

Request

Endpoint

PUT /api/v2/organizations/4b607303-73bf-4ef2-85c0-fc27daad6d66/invites/e0eb3572-8c07-4f6b-981b-414464fc873e/accept
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "organization_invites",
    "attributes": {
      "code": "e9d8b969f1f3bc14f0869bf6921223a7a5529b8bd808b6b50fa5890779d6ffbf"
    }
  }
}

Parameters

Attributes

code

Type Unknown

Description code that matches the code attribute on the invite being accepted

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "e0eb3572-8c07-4f6b-981b-414464fc873e",
    "type": "organization_invites",
    "attributes": {
      "accepted_at": "2021-11-23T14:38:02Z",
      "code": "e9d8b969f1f3bc14f0869bf6921223a7a5529b8bd808b6b50fa5890779d6ffbf",
      "created_at": "2021-11-23T14:38:02Z",
      "invite_user_as": "admin",
      "recipient_email": "[email protected]",
      "updated_at": "2021-11-23T14:38:02Z",
      "updated_in_db_at": "2021-11-23T14:38:02Z"
    },
    "relationships": {
      "accepted_by_user": {
        "data": {
          "id": "5ddd7530-79c6-41c1-8bbc-014bb48d0e0e",
          "type": "users"
        }
      },
      "cancelled_by_user": {
        "data": null
      },
      "invited_by_user": {
        "data": {
          "id": "e62d78a3-5e8e-43b3-8cb3-41af62c600c9",
          "type": "users"
        }
      }
    }
  }
}

Fields

Attributes

accepted_at

Type string

Description Accepted At

code

Type string

Description Code

created_at

Type date

Description The timestamp of when this resource was created

invite_user_as

Type string

Description What to type of association to create if user accepts invite; Accepts "admin"

recipient_email

Type string

Description Recipient Email

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

accepted_by_user.data

Type User

Description user that accepted the invite

cancelled_by_user.data

Type User

Description user that cancelled the invite

invited_by_user.data

Type User

Description user that created the invite