Invites

Invites Documentation

Invite [LIST]

Invite [LIST]

Request

Endpoint

GET /api/v2/organizations/b6a631c3-2745-4595-ad0d-eed1bebaff21/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": "42d53f36-23b6-40ae-9f30-3791a481a3ef",
      "type": "organization_invites",
      "attributes": {
        "accepted_at": "-4712-01-01T00:00:00Z",
        "code": "f3eaf691fe67265a6a7ebfc01b2a6b77b27898c29c00294452bd5fff714ee563",
        "created_at": "2022-01-12T17:18:04Z",
        "invite_user_as": "admin",
        "recipient_email": "[e-mail]",
        "updated_at": "2022-01-12T17:18:04Z",
        "updated_in_db_at": "2022-01-12T17:18:04Z"
      },
      "relationships": {
        "accepted_by_user": {
          "data": null
        },
        "cancelled_by_user": {
          "data": null
        },
        "invited_by_user": {
          "data": {
            "id": "4b1c096f-1024-4be6-b40b-a768eb9bd20f",
            "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/23d886dc-5b17-433c-8764-c71c503e818a/invites
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "organization_invites",
    "attributes": {
      "invite_user_as": "admin",
      "recipient_email": "[e-mail]",
      "updated_in_db_at": "2022-01-12 17:18:03 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": "4808f196-0303-4138-adfd-7d6873db72d0",
    "type": "organization_invites",
    "attributes": {
      "accepted_at": null,
      "code": "056ffc68e515c9b4d274361997c1605aa06f252c14c4b297952736694c74ad23",
      "created_at": "2022-01-12T17:18:03Z",
      "invite_user_as": "admin",
      "recipient_email": "[e-mail]",
      "updated_at": "2022-01-12T17:18:03Z",
      "updated_in_db_at": "2022-01-12T17:18:03Z"
    },
    "relationships": {
      "accepted_by_user": {
        "data": null
      },
      "cancelled_by_user": {
        "data": null
      },
      "invited_by_user": {
        "data": {
          "id": "aed01548-7199-487a-8cd1-3c8c01e562aa",
          "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/d999792f-dd98-4b51-b9e8-f407067aaa9a/invites/b67fb8c0-a2c9-4101-8131-0f70b64fd81d
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "b67fb8c0-a2c9-4101-8131-0f70b64fd81d",
    "type": "organization_invites",
    "attributes": {
      "accepted_at": "-4712-01-01T00:00:00Z",
      "code": "8db37c3d005aa9c964475a9ae6f31c7e1aa9a71c2ef0a3635261f53899681103",
      "created_at": "2022-01-12T17:18:03Z",
      "invite_user_as": "admin",
      "recipient_email": "[e-mail]",
      "updated_at": "2022-01-12T17:18:03Z",
      "updated_in_db_at": "2022-01-12T17:18:03Z"
    },
    "relationships": {
      "accepted_by_user": {
        "data": null
      },
      "cancelled_by_user": {
        "data": null
      },
      "invited_by_user": {
        "data": {
          "id": "6428c41f-b4a7-416b-8142-cd776359b931",
          "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/eca82c2a-3bdd-44b6-a4fb-9b694dc29896/invites/68ae252d-50da-4b87-93ea-db01e4cbd56f
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body

Invite [ACCEPT]

Invite [ACCEPT]

Request

Endpoint

PUT /api/v2/organizations/29c01516-ac37-4427-bcb9-7521824e53a9/invites/2ba9af73-c6ae-46d8-aea3-f0d068e9a75f/accept
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "organization_invites",
    "attributes": {
      "code": "49a2c8861ec91f9c93d946c7df0c0dfc3d45d8f01cfae2eefec2a4113e9c7405"
    }
  }
}

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": "2ba9af73-c6ae-46d8-aea3-f0d068e9a75f",
    "type": "organization_invites",
    "attributes": {
      "accepted_at": "2022-01-12T17:18:04Z",
      "code": "49a2c8861ec91f9c93d946c7df0c0dfc3d45d8f01cfae2eefec2a4113e9c7405",
      "created_at": "2022-01-12T17:18:04Z",
      "invite_user_as": "admin",
      "recipient_email": "[e-mail]",
      "updated_at": "2022-01-12T17:18:04Z",
      "updated_in_db_at": "2022-01-12T17:18:04Z"
    },
    "relationships": {
      "accepted_by_user": {
        "data": {
          "id": "46c18c44-5c6e-4877-bb5b-41a71292d672",
          "type": "users"
        }
      },
      "cancelled_by_user": {
        "data": null
      },
      "invited_by_user": {
        "data": {
          "id": "0f739408-1f86-4238-a970-0346e2d22523",
          "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