Skip to main content
GET
/
admin
/
invitations
List organization invitations
curl --request GET \
  --url https://asteragents.com/api/admin/invitations \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "orginv_2ABC123DEF",
      "emailAddress": "newuser@company.com",
      "role": "org:member",
      "status": "pending",
      "publicMetadata": {
        "department": "sales"
      },
      "createdAt": 1705363800000,
      "updatedAt": 1705363800000
    },
    {
      "id": "orginv_2XYZ789GHI",
      "emailAddress": "admin@company.com",
      "role": "org:admin",
      "status": "pending",
      "publicMetadata": null,
      "createdAt": 1705276800000,
      "updatedAt": 1705276800000
    }
  ],
  "totalCount": 2
}

Authorizations

​
Authorization
string
header
required

JWT token from Clerk authentication.

Must be from a user with org:admin role.

Query Parameters

​
limit
integer
default:100

Number of results to return

Required range: 1 <= x <= 500
​
offset
integer
default:0

Number of results to skip for pagination

Required range: x >= 0
​
status
string
default:pending

Comma-separated list of statuses to filter by

Response

Successfully retrieved invitations

​
data
object[]
required
​
totalCount
integer
required

Total number of invitations matching the filter