Users

Invite a team member

Invite a colleague to your entity using a user API key with users:write and current admin access. Your key must have approved write access to the entity. Entity service keys cannot invite users. Your entity's approval policy applies before the invitation is sent. Your colleague must accept the invitation before gaining access. Existing members, pending invitations, and active invitation requests are rejected. Retrying while a request or invitation is active does not send another invitation.

post/users/invitations

Request

Headers

x-entity-idstring uuid

Optional entity_id to scope requests to a specific entity.

Request body

emailstring email required

Email address of the colleague you want to invite.

role'Admin' | 'Viewer' | 'Bookkeeper' | 'Controller' | 'Card user' | 'Card manager' | 'Invoice user' | 'AP Clerk' | 'AP/AR Bookkeeper' | 'Bill Approver' required

Role your colleague receives after accepting the invitation.

Response

Successful Response

approval_idstring uuid required

Approval ID. Use it with GET /approvals/{approval_id} to check the request status.

status'pending_approval' | 'approved' | 'executing' | 'under_review' | 'completed' | 'rejected' | 'expired' | 'failed' required

Changes

No recorded changes to this operation across all 1 revision of this API.