For the complete documentation index, see llms.txt. This page is also available as Markdown.

Organization Members

Organization Members endpoints

List all members

get
/orgs/{organizationId}/members
Authorizations
AuthorizationstringRequired
Path parameters
organizationIdintegerRequired

The ID of the organization

Query parameters
beforestringOptional

Used as a cursor for pagination.

afterstringOptional

Used as a cursor for pagination.

limitintegerOptional

Set the number of subscriptions to return in the response. This defaults to 20 items, and can be a maximum of 100.

emailstringOptional

Filter the members by email.

Responses
200

The list of members

application/json
get/orgs/{organizationId}/members
GET /api/v2/orgs/{organizationId}/members HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*
{
  "members": [
    {
      "id": 8,
      "email": "jane@doe.com",
      "role": "v",
      "user": {
        "id": 1,
        "last_sign_in_at": "2022-01-01T00:00:00",
        "current_sign_in_at": "2022-01-01T00:00:00"
      },
      "inserted_at": "2022-01-01T00:00:00",
      "updated_at": "2022-01-01T00:00:00"
    }
  ],
  "links": {
    "next": "{STATUSPAL_HOST}/api/v2/orgs/{organizationId}/members?after=cUrSoR",
    "prev": "text"
  },
  "meta": {
    "total_count": 100
  }
}

Adds a new membership

post
/orgs/{organizationId}/members
Authorizations
AuthorizationstringRequired
Path parameters
organizationIdintegerRequired

The ID of the organization

Body
Responses
200

The membership was created

application/json
post/orgs/{organizationId}/members
POST /api/v2/orgs/{organizationId}/members HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "member": {
    "email": "jane@doe.com",
    "role": "v"
  }
}
{
  "member": {
    "id": 8,
    "email": "jane@doe.com",
    "role": "v",
    "user": {
      "id": 1,
      "last_sign_in_at": "2022-01-01T00:00:00",
      "current_sign_in_at": "2022-01-01T00:00:00"
    },
    "inserted_at": "2022-01-01T00:00:00",
    "updated_at": "2022-01-01T00:00:00"
  }
}

Update the membership

put
/orgs/{organizationId}/members/{memberId}
Authorizations
AuthorizationstringRequired
Path parameters
organizationIdintegerRequired

The ID of the organization

memberIdintegerRequired

The ID of a membership

Body
Responses
200

The membership was updated

application/json
put/orgs/{organizationId}/members/{memberId}
PUT /api/v2/orgs/{organizationId}/members/{memberId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "member": {
    "role": "v"
  }
}
{
  "member": {
    "id": 8,
    "email": "jane@doe.com",
    "role": "v",
    "user": {
      "id": 1,
      "last_sign_in_at": "2022-01-01T00:00:00",
      "current_sign_in_at": "2022-01-01T00:00:00"
    },
    "inserted_at": "2022-01-01T00:00:00",
    "updated_at": "2022-01-01T00:00:00"
  }
}

Deletes the membership

delete
/orgs/{organizationId}/members/{memberId}
Authorizations
AuthorizationstringRequired
Path parameters
organizationIdintegerRequired

The ID of the organization

memberIdintegerRequired

The ID of a membership

Responses
204

Member deleted successfully

delete/orgs/{organizationId}/members/{memberId}
DELETE /api/v2/orgs/{organizationId}/members/{memberId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*

No content

Last updated