Skip to main content
GET
/
api
/
v1
/
organization-invitations
/
List
curl --request GET \
  --url https://api.main.apexscore.ai/api/v1/organization-invitations/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "expiry_date": "2023-11-07T05:31:56Z",
      "status": 0,
      "organization": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "inviter_member": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "jsmith@example.com"
      },
      "email": "jsmith@example.com",
      "first_name": "<string>",
      "last_name": "<string>",
      "email_sent": true,
      "role": 0,
      "accessible_portfolios": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
email
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
​
next
string<uri> | null
Example:

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

​
previous
string<uri> | null
Example:

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