Skip to content

Team

Contents 26 pages

The people in your organization, as the web app's Settings → Members shows them. Reading needs team:read. Changing the team needs team:write, which only an owner or admin can grant.

Organizations only: a Shopify store's staff live in Shopify, so a store's key gets not_available_for_shopify.

Who a change acts as#

A team change runs as the owner or admin behind the key: the person who connected the AI app, or who made the key, while they are still an owner or admin of the organization. It follows the web app's rules for that person:

  • An admin invites and manages members. Only the owner invites an admin or changes anyone's role.
  • Nobody changes or removes the owner here, and ownership moves only in the web app.
  • A key never changes or removes the member it acts for (is_you).
  • A key with no owner or admin behind it, such as one ShipEasy's team made for you, gets insufficient_scope on every change.

Leaving an organization and answering an invitation stay in the web app.

List the team#

GET/api/v1/membersScope team:read
Request
curl https://app.shipeasyco.com/api/v1/members \
  -H "Authorization: Bearer $SHIPEASY_API_KEY"
Response
{
	"object": "team",
	"members": [
		{
			"object": "member",
			"id": "cm4u2owner…",
			"email": "maria@acme.test",
			"name": "Maria Lopez",
			"role": "owner",
			"permissions": ["book", "cancelAny", "payments", "allShipments"],
			"status": "active",
			"account_disabled": false,
			"is_you": true,
			"joined_at": "2026-03-02T15:04:05.000Z",
			"last_sign_in_at": "2026-11-18T09:12:00.000Z"
		}
	],
	"invitations": [
		{
			"object": "invitation",
			"id": "cm9inv01…",
			"email": "sam@acme.test",
			"role": "member",
			"invited_by": "maria@acme.test",
			"expires_at": "2026-11-26T10:00:00.000Z",
			"email_sent": null
		}
	]
}

permissions are a member's switches; owners and admins hold every one. status is their standing in this organization (suspended keeps them out of it alone).

Invite someone#

POST/api/v1/invitationsScope team:write
Shell
curl https://app.shipeasyco.com/api/v1/invitations \
  -H "Authorization: Bearer $SHIPEASY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "email": "sam@acme.test", "role": "member", "permissions": ["book"] }'

The email goes out at once, from the person behind the key, with the same link the web app sends. Inviting the same address again sends a fresh link and the old one stops working. permissions are for a member only; left out, a member gets the defaults. The answer is the invitation, with email_sent: false when the email bounced (the list says null, as it does not know).

Withdraw an invitation#

DELETE/api/v1/invitations/{invitationId}Scope team:write

Its link stops working. An invitation already answered, withdrawn or expired is resource_not_found.

Change a member#

PATCH/api/v1/members/{memberId}Scope team:write
Shell
curl -X PATCH https://app.shipeasyco.com/api/v1/members/cm4u2mem… \
  -H "Authorization: Bearer $SHIPEASY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "suspended": true }'

Only the fields sent change: role (member or admin), permissions (the member's switches, whole) and suspended. They apply in that order, and a refusal stops the rest. The answer is the member as it now stands.

Remove a member#

DELETE/api/v1/members/{memberId}Scope team:write

Takes them out of your organization and disconnects the AI apps they connected to it. Their quotes and shipments stay. To pause someone instead, send suspended: true.