Organization
Your organization, its people and its pending invitations.
Get your organization
/v1/orgorg:readHQ-Versionstring (date)A dated API version. Defaults to the version the key was created with.
HQ-AccountstringAgency keys only: the slug of the client organization this request acts for. Required with an agency key, refused with
400 invalid_requeston any other credential. A slug that is not one of your agency's current clients is404 not_found. An agency key is limited to 600 requests a minute per key on EACH API server (the cap is per replica), plus its own budget per client (limit_scope: agency_client), separate from the client's own keys.
Returns a Org object.
200The organization.
OtherAn RFC 9457 problem.
Get the org chart
/v1/org/chartorg:chart.readPeople, AI teams and who each team reports to. Emails only for an admin's key.
On an AI team that turned on Protected files, a key that lacks files:protected.read (or whose person lacks it) gets ai_employee_count and skill_count as null for that team.
HQ-Versionstring (date)A dated API version. Defaults to the version the key was created with.
HQ-AccountstringAgency keys only: the slug of the client organization this request acts for. Required with an agency key, refused with
400 invalid_requeston any other credential. A slug that is not one of your agency's current clients is404 not_found. An agency key is limited to 600 requests a minute per key on EACH API server (the cap is per replica), plus its own budget per client (limit_scope: agency_client), separate from the client's own keys.
Returns a OrgChart object.
200The org chart.
OtherAn RFC 9457 problem.
List members
/v1/membersmembers:readlimitintegerHow many objects to return, 1 to 100. Default 20.
starting_afterstringReturn objects older than this id (the next page).
ending_beforestringReturn objects newer than this id (the previous page).
rolestringOnly members with this role. One of
owner,admin,member.
HQ-Versionstring (date)A dated API version. Defaults to the version the key was created with.
HQ-AccountstringAgency keys only: the slug of the client organization this request acts for. Required with an agency key, refused with
400 invalid_requeston any other credential. A slug that is not one of your agency's current clients is404 not_found. An agency key is limited to 600 requests a minute per key on EACH API server (the cap is per replica), plus its own budget per client (limit_scope: agency_client), separate from the client's own keys.
Returns a list of Member objects.
200A page of members.
OtherAn RFC 9457 problem.
Get a member
/v1/members/{user_id}members:readuser_idstringrequiredA member's user id.
HQ-Versionstring (date)A dated API version. Defaults to the version the key was created with.
HQ-AccountstringAgency keys only: the slug of the client organization this request acts for. Required with an agency key, refused with
400 invalid_requeston any other credential. A slug that is not one of your agency's current clients is404 not_found. An agency key is limited to 600 requests a minute per key on EACH API server (the cap is per replica), plus its own budget per client (limit_scope: agency_client), separate from the client's own keys.
Returns a Member object.
200The member.
OtherAn RFC 9457 problem.
List pending invitations
/v1/invitesmembers:readlimitintegerHow many objects to return, 1 to 100. Default 20.
starting_afterstringReturn objects older than this id (the next page).
ending_beforestringReturn objects newer than this id (the previous page).
HQ-Versionstring (date)A dated API version. Defaults to the version the key was created with.
HQ-AccountstringAgency keys only: the slug of the client organization this request acts for. Required with an agency key, refused with
400 invalid_requeston any other credential. A slug that is not one of your agency's current clients is404 not_found. An agency key is limited to 600 requests a minute per key on EACH API server (the cap is per replica), plus its own budget per client (limit_scope: agency_client), separate from the client's own keys.
Returns a list of Invite objects.
200A page of invitations.
OtherAn RFC 9457 problem.
Invite someone
/v1/invitesmembers:inviteEmails an invitation to join as a member or an admin (never an owner). The plan's seat limit applies (Professional has none), and the API sends at most a daily number of invitations per organization. A key restricted to some AI teams cannot do this (403 team_restricted). Inviting an admin needs members:role.assign in the key's own grant, which no API key can hold, so invite admins in HQ (403).
Idempotency-KeystringMakes a retry safe: the same key and body within 24 hours returns the first response again (
Idempotent-Replayed: true); the same key with another body is 422.HQ-Versionstring (date)A dated API version. Defaults to the version the key was created with.
HQ-AccountstringAgency keys only: the slug of the client organization this request acts for. Required with an agency key, refused with
400 invalid_requeston any other credential. A slug that is not one of your agency's current clients is404 not_found. An agency key is limited to 600 requests a minute per key on EACH API server (the cap is per replica), plus its own budget per client (limit_scope: agency_client), separate from the client's own keys.
emailstring (email)requiredrolestringOne of
member,admin.titlestring or null
Returns a Invite object.
201The invitation.
OtherAn RFC 9457 problem.
Revoke an invitation
/v1/invites/{invite_id}members:inviteinvite_idstringrequiredAn invitation id.
Idempotency-KeystringMakes a retry safe: the same key and body within 24 hours returns the first response again (
Idempotent-Replayed: true); the same key with another body is 422.HQ-Versionstring (date)A dated API version. Defaults to the version the key was created with.
HQ-AccountstringAgency keys only: the slug of the client organization this request acts for. Required with an agency key, refused with
400 invalid_requeston any other credential. A slug that is not one of your agency's current clients is404 not_found. An agency key is limited to 600 requests a minute per key on EACH API server (the cap is per replica), plus its own budget per client (limit_scope: agency_client), separate from the client's own keys.
204Revoked. Its link no longer works.
OtherAn RFC 9457 problem.
Resend an invitation
/v1/invites/{invite_id}/resendmembers:inviteSends a new link (the old one stops working) and extends the expiry.
invite_idstringrequiredAn invitation id.
Idempotency-KeystringMakes a retry safe: the same key and body within 24 hours returns the first response again (
Idempotent-Replayed: true); the same key with another body is 422.HQ-Versionstring (date)A dated API version. Defaults to the version the key was created with.
HQ-AccountstringAgency keys only: the slug of the client organization this request acts for. Required with an agency key, refused with
400 invalid_requeston any other credential. A slug that is not one of your agency's current clients is404 not_found. An agency key is limited to 600 requests a minute per key on EACH API server (the cap is per replica), plus its own budget per client (limit_scope: agency_client), separate from the client's own keys.
Returns a Invite object.
200The invitation.
OtherAn RFC 9457 problem.
Objects
Org
objectstringidstringnamestringslugstringplanstringplan_statusstringtrial_ends_atstring or nullcurrent_period_endstring or nullcancel_at_period_endbooleancreated_atstring (date-time)
OrgChart
objectstringownersarray of objectpeoplearray of objectpending_invitesarray of objectteamsarray of object
Member
objectstringidstringnamestringemailstringrolestringOne of
owner,admin,member.titlestring or nulltwo_factor_enabledbooleanjoined_atstring (date-time)last_login_atstring or null
Invite
objectstringidstringemailstringrolestringtitlestring or nullinvited_byUserRefcreated_atstring (date-time)expires_atstring (date-time)