List

GET

api

organization-invitations

List

curl --request GET \
  --url https://api.main.apexscore.ai/api/v1/organization-invitations/ \
  --header 'Authorization: Bearer <token>'

{
  "count": 123,
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "expiry_date": "2023-11-07T05:31:56Z",
      "organization": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "inviter_member": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "[email protected]"
      },
      "email": "[email protected]",
      "email_sent": true,
      "accessible_portfolios": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>"
        }
      ],
      "status": 0,
      "first_name": "<string>",
      "last_name": "<string>",
      "role": 0
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

string

organization_id

string<uuid>

Invitee's/Inviter's organization.

page

integer

A page number within the paginated result set.

page_size

integer

Number of results to return per page.

status

enum<integer>

Status of the invitation, default status is pending.

0 - pending
1 - accepted
2 - cancelled
3 - expired
4 - revoked

Available options:

0,

1,

2,

3,

4

token

string<uuid>

Response

200 - application/json

count

integer

required

Example:

123

results

object[]

required

Show child attributes

results.id

string<uuid>

required

results.token

string<uuid>

required

Token is used to validate the invitation.

results.expiry_date

string<date-time>

required

Date is calculated in save().

results.organization

object

required

Show child attributes

results.organization.id

string<uuid>

required

results.organization.name

string | null

Maximum string length: 100

results.inviter_member

object

required

Show child attributes

results.inviter_member.id

string<uuid>

required

results.inviter_member.first_name

string

required

results.inviter_member.last_name

string

required

results.inviter_member.email

string<email>

required

results.email

string<email>

required

Invitee's email address.

Maximum string length: 255

results.email_sent

boolean

required

results.accessible_portfolios

object[]

required

Show child attributes

results.accessible_portfolios.id

string<uuid>

required

results.accessible_portfolios.name

string

results.status

enum<integer>

Status of the invitation, default status is pending.

0 - pending
1 - accepted
2 - cancelled
3 - expired
4 - revoked

Available options:

0,

1,

2,

3,

4

Required range: -2147483648 <= x <= 2147483647

results.first_name

string | null

Invitee's first name.

Maximum string length: 25

results.last_name

string | null

Invitee's last name.

Maximum string length: 25

results.role

enum<integer>

Invitee's role, default role is member.

0 - member
1 - collaborator
2 - administrator

Available options:

0,

1,

2

Required range: -2147483648 <= x <= 2147483647

string<uri> | null

Example:

"http://api.example.org/accounts/?page=4"

string<uri> | null

Example:

"http://api.example.org/accounts/?page=2"

CreateCreate organization invitation to given email addresses. A caller may pass an array of data to create invitations in bulk. See examples. When creating a COLLABORATOR role (`role` = 1), a `accessible_portfolio_ids` parameter is required to assign the collaborator specific portfolio access. If this is not sent, the invitation will fail. If this is sent when creating an ADMIN or MEMBER invitation, it will be ignored because they have access to all portfolios of an organization. See examples. Will return 201 on complete (all invites) success, or 202 when the request completed but there were errors with at least one invite.

⌘I

List

curl --request GET \
  --url https://api.main.apexscore.ai/api/v1/organization-invitations/ \
  --header 'Authorization: Bearer <token>'

{
  "count": 123,
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "expiry_date": "2023-11-07T05:31:56Z",
      "organization": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "inviter_member": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "[email protected]"
      },
      "email": "[email protected]",
      "email_sent": true,
      "accessible_portfolios": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>"
        }
      ],
      "status": 0,
      "first_name": "<string>",
      "last_name": "<string>",
      "role": 0
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

API Documentation

Endpoint Examples

Authorizations

Query Parameters

Response