Skip to main content
GET
/
organizations
/
{organizationID}
/
invitations
List invitations for an organization
curl --request GET \
  --url https://api.xata.tech/organizations/{organizationID}/invitations \
  --header 'Authorization: Bearer <token>'
{
  "invitations": [
    {
      "id": "<string>",
      "organization_id": "<string>",
      "email": "jsmith@example.com",
      "created_at": "2023-11-07T05:31:56Z",
      "expires_at": "2023-11-07T05:31:56Z",
      "status": "pending",
      "first_name": "<string>",
      "last_name": "<string>",
      "invite_link": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
organizationID
string
required

Unique identifier for a specific organization

Query Parameters

​
status
enum<string>

Filter invitations by status

Available options:
pending,
expired
​
email
string

Filter invitations by email address

​
first_name
string

Filter invitations by first name

​
last_name
string

Filter invitations by last name

​
search
string

Search invitations by email or name

​
first
integer
default:0

Index of the first result to return (0-based offset for pagination)

Required range: x >= 0
​
max
integer
default:100

Maximum number of results to return

Required range: 1 <= x <= 100

Response

List of invitations retrieved successfully

​
invitations
object[]
required