Members & invitations

200 success

The roster.

As application/json.

seatsOrgSeatStatealways present

The organization's seat counter. A seat is what makes a member's access paid; a member without one is a free member.

seats.includedintegeralways present

Seats the plan includes (an unexpired DTG override of seats_included replaces the plan's figure), raised to grandfathered while that is set.

seats.grandfatheredinteger or null

T163: an organization that had more seated members than its plan's new included count when Regional fell to 10 seats and National to 15 keeps that many included seats until its seated members fall to the plan's count or its plan changes. This is that count; null for every other organization.

seats.purchasedintegeralways present

Extra seats the organization has bought (POST /v2/account/seats).

seats.capacityintegeralways present

included + purchased: how many members may be seated.

seats.seatedintegeralways present

Active members holding a seat now (owners and admins included). Can exceed capacity, because owners and admins are always seated.

seats.freeintegeralways present

Active members without a seat (free members).

seats.availableintegeralways present

Seats free to give, max(0, capacity - seated). Seating a member needs this above 0.

seats.seat_price_usd_monthstring or nullalways present

The plan's monthly price of one extra seat in US dollars, as a decimal string (for example "8.00"); null on a plan that sells no seats. Kept for older clients; prefer seat_price_usd.

seats.seat_price_usdnumber or nullalways present

The price of one extra seat in US dollars for the plan's billing interval (seat_price_interval), read from the payment catalog as a checkout charges it. Null on a plan that sells no seats.

seats.seat_price_interval"month" | "year"always present

The billing interval seat_price_usd is charged per (the subscription's interval; month when there is none).

dataarray of OrgMemberalways present

Seated members, owners first, then admins, then by join date.

data[].idstring (uuid)always present

The membership id (the {id} of /v2/account/members/{id}). Not the account id.

data[].emailstring (email)always present

The member's sign-in address.

data[].display_namestring or nullalways present

The member's display name; null when they never set one.

data[].role"owner" | "admin" | "member"always present

A member's role in an organization (ORG_LICENSING section 7.1). owner: everything, including roles, ownership transfer, closing the organization and billing. admin: manages members, invitations, domains and join requests, but never an owner's membership. member: uses the product. Owners and admins always hold a seat. Billing rights are a separate flag (billing_contact).

data[].billing_contactbooleanalways present

True when the member may see and manage billing (invoices, payment method) although not an owner.

data[].seatedbooleanalways present

True when the member holds a seat (paid access). False is a free member, who resolves to the Free plan's scope inside this organization.

data[].api_enabledbooleanalways present

True when an owner or admin has allowed this member to hold live API keys (needs a seat and the organization's API add-on).

data[].status"active"always present

Always active here; removed members are not listed.

data[].last_active_atstring (date-time) or nullalways present

The member's most recent successful data request on any channel (written at most every five minutes); null when they have made none. This is what monthly active users count.

data[].joined_atstring (date-time)always present

When the membership began (or began again, for a returning member).

data[].active_keysintegeralways present

The member's unrevoked API keys in this organization, live and sandbox together.

free_membersarray of OrgMemberalways present

Members without a seat, by join date.

free_members[].idstring (uuid)always present

The membership id (the {id} of /v2/account/members/{id}). Not the account id.

free_members[].emailstring (email)always present

The member's sign-in address.

free_members[].display_namestring or nullalways present

The member's display name; null when they never set one.

free_members[].role"owner" | "admin" | "member"always present

A member's role in an organization (ORG_LICENSING section 7.1). owner: everything, including roles, ownership transfer, closing the organization and billing. admin: manages members, invitations, domains and join requests, but never an owner's membership. member: uses the product. Owners and admins always hold a seat. Billing rights are a separate flag (billing_contact).

free_members[].billing_contactbooleanalways present

True when the member may see and manage billing (invoices, payment method) although not an owner.

free_members[].seatedbooleanalways present

True when the member holds a seat (paid access). False is a free member, who resolves to the Free plan's scope inside this organization.

free_members[].api_enabledbooleanalways present

True when an owner or admin has allowed this member to hold live API keys (needs a seat and the organization's API add-on).

free_members[].status"active"always present

Always active here; removed members are not listed.

free_members[].last_active_atstring (date-time) or nullalways present

The member's most recent successful data request on any channel (written at most every five minutes); null when they have made none. This is what monthly active users count.

free_members[].joined_atstring (date-time)always present

When the membership began (or began again, for a returning member).

free_members[].active_keysintegeralways present

The member's unrevoked API keys in this organization, live and sandbox together.

reassignment_pendingbooleanalways present

True after a plan change unseated members to fit a smaller seat count and no admin has changed a seat since. The first seat change after that is the free reassignment; any seat change clears the flag.

401 error

Unauthorized. Codes: unauthenticated (no credential, or the key or session is not valid); key_revoked (an API key that was revoked: revoked_at, and reason -- holder, admin, member_removed, seat_removed, api_disabled, addon_ended, account_closed, org_closed, retired, or null for a key revoked before T110 -- and a sentence saying when and why).

As application/problem+json.

403 error

Forbidden. Codes: no_membership (the account has no active organization membership), account_suspended, org_suspended (DTG suspended the organization; carries organization and possibly reason), org_closed (the organization is closed; carries organization), wrong_instance (a key of the mode this process does not serve; base_url names the address that serves it).

As application/problem+json.

404 error

Not found. Codes: not_found (X-DTG-Org names an organization the caller is not an active member of).

As application/problem+json.

429 error

rate_limited (the per-minute ceiling, X-RateLimit-* say which), points_exhausted (the monthly points allowance; Retry-After to the end of the UTC month), server_busy or sandbox_busy (load; retry after Retry-After). A refused server_busy request is not metered.

As application/problem+json.

Retry-After header

Seconds to wait before retrying.

X-RateLimit-Limit header

The per-minute request ceiling that applies.

X-RateLimit-Remaining header

Requests left in the current window.

X-RateLimit-Reset header

Seconds until the window refills: on every answer, the time until the bucket is full again; on a refusal, until a request is allowed (as Retry-After).

201 success

One result per address.

As application/json.

dataarray of OrgInviteResultalways present

One result per distinct address, in request order.

data[].emailstringalways present

The address as processed (trimmed, lower-cased).

data[].status"invited" | "invalid" | "already_member"always present

invited: an invitation was created and mailed. invalid: not a usable address, nothing sent. already_member: the address already belongs to an active member, nothing sent.

data[].invite_idstring (uuid)

The new invitation's id. Present only when status is invited.

data[].expires_atstring (date-time)

When the invitation link stops working (14 days by default, rules.link_lifetimes.invitation_days). Present only when status is invited.

400 error

Bad request. Codes: bad_request (neither email nor emails gave an address, or more than 200 addresses), malformed_json (the body is not valid JSON).

As application/problem+json.

401 error

Unauthorized. Codes: unauthenticated (no credential, or the key or session is not valid); key_revoked (an API key that was revoked: revoked_at, and reason -- holder, admin, member_removed, seat_removed, api_disabled, addon_ended, account_closed, org_closed, retired, or null for a key revoked before T110 -- and a sentence saying when and why).

As application/problem+json.

403 error

Forbidden. Codes: role_required (the caller is a member, or an admin inviting with role: admin; carries required), no_membership, account_suspended, org_suspended, org_closed, wrong_instance (see GET /v2/account/members; base_url names the address that serves the key). A sandbox key: sandbox_read_only (it may write only clusters).

As application/problem+json.

404 error

Not found. Codes: not_found (X-DTG-Org names an organization the caller is not an active member of).

As application/problem+json.

413 error

Payload too large. Codes: body_too_large (over 256 KB; carries limit_bytes).

As application/problem+json.

429 error

rate_limited (the per-minute ceiling, X-RateLimit-* say which), points_exhausted (the monthly points allowance; Retry-After to the end of the UTC month), server_busy or sandbox_busy (load; retry after Retry-After). A refused server_busy request is not metered.

As application/problem+json.

Retry-After header

Seconds to wait before retrying.

X-RateLimit-Limit header

The per-minute request ceiling that applies.

X-RateLimit-Remaining header

Requests left in the current window.

X-RateLimit-Reset header

Seconds until the window refills: on every answer, the time until the bucket is full again; on a refusal, until a request is allowed (as Retry-After).

204 success

Left. No body.

401 error

Unauthorized. Codes: unauthenticated (no credential, or the key or session is not valid); key_revoked (an API key that was revoked: revoked_at, and reason -- holder, admin, member_removed, seat_removed, api_disabled, addon_ended, account_closed, org_closed, retired, or null for a key revoked before T110 -- and a sentence saying when and why).

As application/problem+json.

403 error

Forbidden. Codes: no_membership, account_suspended, org_suspended, org_closed, wrong_instance (see GET /v2/account/members; base_url names the address that serves the key). A sandbox key: sandbox_read_only (it may write only clusters).

As application/problem+json.

404 error

Not found. Codes: not_found (X-DTG-Org names an organization the caller is not an active member of).

As application/problem+json.

409 error

Conflict. Codes: last_owner (the caller is the organization's only owner; carries organizations: [{orgId, name}], the body account close also answers with).

As application/problem+json.

429 error

rate_limited (the per-minute ceiling, X-RateLimit-* say which), points_exhausted (the monthly points allowance; Retry-After to the end of the UTC month), server_busy or sandbox_busy (load; retry after Retry-After). A refused server_busy request is not metered.

As application/problem+json.

Retry-After header

Seconds to wait before retrying.

X-RateLimit-Limit header

The per-minute request ceiling that applies.

X-RateLimit-Remaining header

Requests left in the current window.

X-RateLimit-Reset header

Seconds until the window refills: on every answer, the time until the bucket is full again; on a refusal, until a request is allowed (as Retry-After).

200 success

The membership after the change.

As application/json.

idstring (uuid)always present

The membership id.

org_idstring (uuid)always present

The organization's id.

account_idstring (uuid)always present

The member's account id.

role"owner" | "admin" | "member"always present

A member's role in an organization (ORG_LICENSING section 7.1). owner: everything, including roles, ownership transfer, closing the organization and billing. admin: manages members, invitations, domains and join requests, but never an owner's membership. member: uses the product. Owners and admins always hold a seat. Billing rights are a separate flag (billing_contact).

billing_contactbooleanalways present

True when the member may manage billing.

seatedbooleanalways present

True when the member holds a seat.

api_enabledbooleanalways present

True when the member may hold live API keys.

status"active"always present

Always active (a removed membership cannot be changed).

last_active_atstring (date-time) or nullalways present

The member's most recent successful data request; null when none.

joined_atstring (date-time)always present

When the membership began.

removed_atstring (date-time) or nullalways present

Always null on an active membership (set when a membership is removed).

emailstring (email)always present

The member's sign-in address.

400 error

Bad request. Codes: bad_request (a field of the wrong type or value, nothing to update, unseating an owner or admin, or api_enabled: true for an unseated member), malformed_json (the body is not valid JSON).

As application/problem+json.

401 error

Unauthorized. Codes: unauthenticated (no credential, or the key or session is not valid); key_revoked (an API key that was revoked: revoked_at, and reason -- holder, admin, member_removed, seat_removed, api_disabled, addon_ended, account_closed, org_closed, retired, or null for a key revoked before T110 -- and a sentence saying when and why).

As application/problem+json.

403 error

Forbidden. Codes: role_required (the caller is a member, or an admin sent role; carries required when raised by the role check), owner_row_protected (an admin changing an owner's membership), plan_required (api_enabled: true without the API add-on; carries entitlement: api_access), no_membership, account_suspended, org_suspended, org_closed, wrong_instance (see GET /v2/account/members; base_url names the address that serves the key). A sandbox key: sandbox_read_only (it may write only clusters).

As application/problem+json.

404 error

Not found. Codes: not_found (no active member with that id in this organization, or X-DTG-Org names an organization the caller is not an active member of).

As application/problem+json.

409 error

Conflict. Codes: no_seat_available (seating needs a free seat; carries seats; buy one with POST /v2/account/seats), last_owner (demoting the only owner; transfer ownership first).

As application/problem+json.

413 error

Payload too large. Codes: body_too_large (over 256 KB; carries limit_bytes).

As application/problem+json.

429 error

rate_limited (the per-minute ceiling, X-RateLimit-* say which), points_exhausted (the monthly points allowance; Retry-After to the end of the UTC month), server_busy or sandbox_busy (load; retry after Retry-After). A refused server_busy request is not metered.

As application/problem+json.

Retry-After header

Seconds to wait before retrying.

X-RateLimit-Limit header

The per-minute request ceiling that applies.

X-RateLimit-Remaining header

Requests left in the current window.

X-RateLimit-Reset header

Seconds until the window refills: on every answer, the time until the bucket is full again; on a refusal, until a request is allowed (as Retry-After).

204 success

Removed. No body.

401 error

Unauthorized. Codes: unauthenticated (no credential, or the key or session is not valid); key_revoked (an API key that was revoked: revoked_at, and reason -- holder, admin, member_removed, seat_removed, api_disabled, addon_ended, account_closed, org_closed, retired, or null for a key revoked before T110 -- and a sentence saying when and why).

As application/problem+json.

403 error

Forbidden. Codes: role_required (the caller is a member, or an admin removing an owner), no_membership, account_suspended, org_suspended, org_closed, wrong_instance (see GET /v2/account/members; base_url names the address that serves the key). A sandbox key: sandbox_read_only (it may write only clusters).

As application/problem+json.

404 error

Not found. Codes: not_found (no active member with that id in this organization, or X-DTG-Org names an organization the caller is not an active member of).

As application/problem+json.

409 error

Conflict. Codes: last_owner (the member is the organization's only owner; transfer ownership first).

As application/problem+json.

429 error

rate_limited (the per-minute ceiling, X-RateLimit-* say which), points_exhausted (the monthly points allowance; Retry-After to the end of the UTC month), server_busy or sandbox_busy (load; retry after Retry-After). A refused server_busy request is not metered.

As application/problem+json.

Retry-After header

Seconds to wait before retrying.

X-RateLimit-Limit header

The per-minute request ceiling that applies.

X-RateLimit-Remaining header

Requests left in the current window.

X-RateLimit-Reset header

Seconds until the window refills: on every answer, the time until the bucket is full again; on a refusal, until a request is allowed (as Retry-After).

200 success

Ownership transferred.

As application/json.

owner_membership_idstring (uuid)always present

The membership that is now an owner (the {id} of the request).

previous_owner_membership_idstring (uuid)always present

The caller's membership, which stepped down.

previous_owner_role"admin"always present

The caller's role now. Always admin (still seated).

400 error

Bad request. Codes: bad_request ({id} is the caller's own membership).

As application/problem+json.

401 error

Unauthorized. Codes: unauthenticated (no credential, or the key or session is not valid); key_revoked (an API key that was revoked: revoked_at, and reason -- holder, admin, member_removed, seat_removed, api_disabled, addon_ended, account_closed, org_closed, retired, or null for a key revoked before T110 -- and a sentence saying when and why).

As application/problem+json.

403 error

Forbidden. Codes: role_required (the caller is not an owner; carries required), no_membership, account_suspended, org_suspended, org_closed, wrong_instance (see GET /v2/account/members; base_url names the address that serves the key). A sandbox key: sandbox_read_only (it may write only clusters).

As application/problem+json.

404 error

Not found. Codes: not_found (no active member with that id in this organization, or X-DTG-Org names an organization the caller is not an active member of).

As application/problem+json.

429 error

rate_limited (the per-minute ceiling, X-RateLimit-* say which), points_exhausted (the monthly points allowance; Retry-After to the end of the UTC month), server_busy or sandbox_busy (load; retry after Retry-After). A refused server_busy request is not metered.

As application/problem+json.

Retry-After header

Seconds to wait before retrying.

X-RateLimit-Limit header

The per-minute request ceiling that applies.

X-RateLimit-Remaining header

Requests left in the current window.

X-RateLimit-Reset header

Seconds until the window refills: on every answer, the time until the bucket is full again; on a refusal, until a request is allowed (as Retry-After).

200 success

The claim, or null.

As application/json.

notice_daysintegeralways present

The notice window in days (ORG_LICENSING section 7.3; 7 by default, also served as rules.ownership_claim_notice_days).

claimOrgOwnershipClaim or nullalways present

The open claim, else the most recently cancelled one within one notice window, else null.

claim.idstring (uuid)

The claim's id.

claim.status"pending" | "cancelled"

pending: open and counting down. cancelled: ended without completing (see cancel_reason).

claim.opened_atstring (date-time)

When the claim was made and the owners were mailed.

claim.completes_atstring (date-time)

When a pending claim completes (opened_at plus notice_days).

claim.cancelled_atstring (date-time)

When the claim was cancelled. Present only when status is cancelled.

claim.cancel_reason"owner_present" | "claimant_left"

Present only when status is cancelled. owner_present: an owner signed in or made a request on a session during the window (an API key never counts). claimant_left: the claimant was removed, left, or closed their account.

claim.owner_present_atstring (date-time) or null

Present only when status is cancelled. When the owner's presence was recorded; null when the reason is claimant_left.

claim.claimantOrgClaimant

The admin making the claim, as the claim remembers them (their address and display name when it was made).

claim.claimant.membership_idstring (uuid)always present

The claimant's membership id.

claim.claimant.emailstring or nullalways present

The claimant's address when they claimed. Null only for an old claim with no remembered address whose claimant has since closed their account.

claim.claimant.display_namestring or nullalways present

The claimant's display name when they claimed; null when they had none. "A former member" when neither the claim nor a live account can name them.

claim.you_are"claimant" | "owner" | "admin"

The caller's relation to the claim, so one screen can say "your claim" or "a claim against you".

401 error

Unauthorized. Codes: unauthenticated (no credential, or the key or session is not valid); key_revoked (an API key that was revoked: revoked_at, and reason -- holder, admin, member_removed, seat_removed, api_disabled, addon_ended, account_closed, org_closed, retired, or null for a key revoked before T110 -- and a sentence saying when and why).

As application/problem+json.

403 error

Forbidden. Codes: role_required (the caller is a member; carries required), no_membership, account_suspended, org_suspended, org_closed, wrong_instance (see GET /v2/account/members; base_url names the address that serves the key).

As application/problem+json.

404 error

Not found. Codes: not_found (X-DTG-Org names an organization the caller is not an active member of).

As application/problem+json.

429 error

rate_limited (the per-minute ceiling, X-RateLimit-* say which), points_exhausted (the monthly points allowance; Retry-After to the end of the UTC month), server_busy or sandbox_busy (load; retry after Retry-After). A refused server_busy request is not metered.

As application/problem+json.

Retry-After header

Seconds to wait before retrying.

X-RateLimit-Limit header

The per-minute request ceiling that applies.

X-RateLimit-Remaining header

Requests left in the current window.

X-RateLimit-Reset header

Seconds until the window refills: on every answer, the time until the bucket is full again; on a refusal, until a request is allowed (as Retry-After).

200 success

A claim was already open; it is returned unchanged.

As application/json.

idstring (uuid)always present

The claim's id.

completes_atstring (date-time)always present

When the claim completes unless an owner is present first.

status"pending"always present

Always pending.

201 success

The claim was opened and the owners notified.

As application/json.

idstring (uuid)always present

The claim's id.

completes_atstring (date-time)always present

When the claim completes unless an owner is present first.

status"pending"always present

Always pending.

401 error

Unauthorized. Codes: unauthenticated (no credential, or the key or session is not valid); key_revoked (an API key that was revoked: revoked_at, and reason -- holder, admin, member_removed, seat_removed, api_disabled, addon_ended, account_closed, org_closed, retired, or null for a key revoked before T110 -- and a sentence saying when and why).

As application/problem+json.

403 error

Forbidden. Codes: role_required (the caller is not an admin), domain_verification_required (the caller's address is unverified or not at a domain this organization has verified), no_membership, account_suspended, org_suspended, org_closed, wrong_instance (see GET /v2/account/members; base_url names the address that serves the key). A sandbox key: sandbox_read_only (it may write only clusters).

As application/problem+json.

404 error

Not found. Codes: not_found (X-DTG-Org names an organization the caller is not an active member of).

As application/problem+json.

409 error

Conflict. Codes: owner_active (an owner signed in or made a session request within the notice window; ask them to transfer ownership).

As application/problem+json.

429 error

rate_limited (the per-minute ceiling, X-RateLimit-* say which), points_exhausted (the monthly points allowance; Retry-After to the end of the UTC month), server_busy or sandbox_busy (load; retry after Retry-After). A refused server_busy request is not metered.

As application/problem+json.

Retry-After header

Seconds to wait before retrying.

X-RateLimit-Limit header

The per-minute request ceiling that applies.

X-RateLimit-Remaining header

Requests left in the current window.

X-RateLimit-Reset header

Seconds until the window refills: on every answer, the time until the bucket is full again; on a refusal, until a request is allowed (as Retry-After).

200 success

The pending invitations.

As application/json.

dataarray of OrgPendingInvitealways present

Pending invitations, newest first.

data[].idstring (uuid)always present

The invitation's id.

data[].emailstringalways present

The invited address.

data[].role"member" | "admin"always present

The role the invitee joins with.

data[].expires_atstring (date-time)always present

When the link stops working.

data[].created_atstring (date-time)always present

When the invitation was first made (a resend does not change it).

data[].invited_bystringalways present

The sign-in address of the person who invited.

data[].expiredbooleanalways present

True when expires_at has passed; resend to issue a fresh link.

401 error

Unauthorized. Codes: unauthenticated (no credential, or the key or session is not valid); key_revoked (an API key that was revoked: revoked_at, and reason -- holder, admin, member_removed, seat_removed, api_disabled, addon_ended, account_closed, org_closed, retired, or null for a key revoked before T110 -- and a sentence saying when and why).

As application/problem+json.

403 error

Forbidden. Codes: no_membership, account_suspended, org_suspended, org_closed, wrong_instance (see GET /v2/account/members; base_url names the address that serves the key).

As application/problem+json.

404 error

Not found. Codes: not_found (X-DTG-Org names an organization the caller is not an active member of).

As application/problem+json.

429 error

rate_limited (the per-minute ceiling, X-RateLimit-* say which), points_exhausted (the monthly points allowance; Retry-After to the end of the UTC month), server_busy or sandbox_busy (load; retry after Retry-After). A refused server_busy request is not metered.

As application/problem+json.

Retry-After header

Seconds to wait before retrying.

X-RateLimit-Limit header

The per-minute request ceiling that applies.

X-RateLimit-Remaining header

Requests left in the current window.

X-RateLimit-Reset header

Seconds until the window refills: on every answer, the time until the bucket is full again; on a refusal, until a request is allowed (as Retry-After).

204 success

Revoked. No body.

401 error

Unauthorized. Codes: unauthenticated (no credential, or the key or session is not valid); key_revoked (an API key that was revoked: revoked_at, and reason -- holder, admin, member_removed, seat_removed, api_disabled, addon_ended, account_closed, org_closed, retired, or null for a key revoked before T110 -- and a sentence saying when and why).

As application/problem+json.

403 error

Forbidden. Codes: role_required (the caller is a member; carries required), no_membership, account_suspended, org_suspended, org_closed, wrong_instance (see GET /v2/account/members; base_url names the address that serves the key). A sandbox key: sandbox_read_only (it may write only clusters).

As application/problem+json.

404 error

Not found. Codes: not_found (no pending invitation with that id here, or X-DTG-Org names an organization the caller is not an active member of).

As application/problem+json.

429 error

rate_limited (the per-minute ceiling, X-RateLimit-* say which), points_exhausted (the monthly points allowance; Retry-After to the end of the UTC month), server_busy or sandbox_busy (load; retry after Retry-After). A refused server_busy request is not metered.

As application/problem+json.

Retry-After header

Seconds to wait before retrying.

X-RateLimit-Limit header

The per-minute request ceiling that applies.

X-RateLimit-Remaining header

Requests left in the current window.

X-RateLimit-Reset header

Seconds until the window refills: on every answer, the time until the bucket is full again; on a refusal, until a request is allowed (as Retry-After).

200 success

Resent.

As application/json.

idstring (uuid)always present

The invitation's id (unchanged).

expires_atstring (date-time)always present

The fresh link's expiry.

401 error

Unauthorized. Codes: unauthenticated (no credential, or the key or session is not valid); key_revoked (an API key that was revoked: revoked_at, and reason -- holder, admin, member_removed, seat_removed, api_disabled, addon_ended, account_closed, org_closed, retired, or null for a key revoked before T110 -- and a sentence saying when and why).

As application/problem+json.

403 error

Forbidden. Codes: role_required (the caller is a member; carries required), no_membership, account_suspended, org_suspended, org_closed, wrong_instance (see GET /v2/account/members; base_url names the address that serves the key). A sandbox key: sandbox_read_only (it may write only clusters).

As application/problem+json.

404 error

Not found. Codes: not_found (no pending invitation with that id here, or X-DTG-Org names an organization the caller is not an active member of).

As application/problem+json.

429 error

rate_limited (the per-minute ceiling, X-RateLimit-* say which), points_exhausted (the monthly points allowance; Retry-After to the end of the UTC month), server_busy or sandbox_busy (load; retry after Retry-After). A refused server_busy request is not metered.

As application/problem+json.

Retry-After header

Seconds to wait before retrying.

X-RateLimit-Limit header

The per-minute request ceiling that applies.

X-RateLimit-Remaining header

Requests left in the current window.

X-RateLimit-Reset header

Seconds until the window refills: on every answer, the time until the bucket is full again; on a refusal, until a request is allowed (as Retry-After).

200 success

The invitation.

As application/json.

emailstringalways present

The address the invitation was sent to; only that address can accept it.

role"member" | "admin"always present

The role the invitee joins with.

expires_atstring (date-time)always present

When the link stops working.

org_namestringalways present

The inviting organization's name.

expiredbooleanalways present

True when expires_at has passed. An expired invitation cannot be accepted; ask for a new one.

lifetime_daysintegeralways present

How many days an invitation lasts (14 by default).

inviterobjectalways present

Who sent the invitation.

inviter.display_namestring or nullalways present

The inviter's display name, else their address; null when the inviter's account has closed.

inviter.organizationstringalways present

The inviting organization's name (the same as org_name).

org_domainstring or nullalways present

The inviting organization's verified domain (its first, by verification time), as the invitation mail names it; null when it has none. A name with no verified domain beside it is unverified.

signup_verifiedtrue

Present only for an unexpired invitation. Always true; an account made through POST /v2/invites/sign-up with this token is verified by it.

account_existsboolean

Present only for an unexpired invitation. True when the invited address already has an account (sign in and accept); false means sign up from the invitation.

400 error

Bad request. Codes: bad_request (token is missing or empty).

As application/problem+json.

404 error

Not found. Codes: not_found (the token is not an open invitation).

As application/problem+json.

200 success

Joined.

As application/json.

organizationobjectalways present

The organization, by id and name.

organization.idstring (uuid)always present

The organization joined. Send it as X-DTG-Org to act in it.

organization.namestringalways present

The organization's name.

membership_idstring (uuid)always present

The new (or re-activated) membership's id.

role"member" | "admin"always present

The role the invitation carried.

seatedbooleanalways present

True when a seat was taken. An admin is always seated; a member is seated only when a seat was free, else joins as a free member.

400 error

Bad request. Codes: bad_request (token missing or empty), malformed_json (the body is not valid JSON).

As application/problem+json.

401 error

Unauthorized. Codes: unauthenticated (no credential, or the key or session is not valid); key_revoked (an API key that was revoked: revoked_at, and reason -- holder, admin, member_removed, seat_removed, api_disabled, addon_ended, account_closed, org_closed, retired, or null for a key revoked before T110 -- and a sentence saying when and why).

As application/problem+json.

403 error

Forbidden. Codes: email_mismatch (the invitation was sent to a different address), email_unverified (verify your address first), wrong_instance (a key of the mode this process does not serve; base_url names the address that serves it). A sandbox key: sandbox_read_only (it may write only clusters).

As application/problem+json.

404 error

Not found. Codes: not_found (the token is not an open invitation, or X-DTG-Org names an organization the caller is not an active member of).

As application/problem+json.

409 error

Conflict. Codes: already_member (the caller is already an active member; carries the membership as it stands).

As application/problem+json.

410 error

Gone. Codes: invite_expired (carries expired_at and lifetime_days; ask for a new invitation).

As application/problem+json.

413 error

Payload too large. Codes: body_too_large (over 4 KB; carries limit_bytes).

As application/problem+json.

429 error

rate_limited (the per-minute ceiling, X-RateLimit-* say which), points_exhausted (the monthly points allowance; Retry-After to the end of the UTC month), server_busy or sandbox_busy (load; retry after Retry-After). A refused server_busy request is not metered.

As application/problem+json.

Retry-After header

Seconds to wait before retrying.

X-RateLimit-Limit header

The per-minute request ceiling that applies.

X-RateLimit-Remaining header

Requests left in the current window.

X-RateLimit-Reset header

Seconds until the window refills: on every answer, the time until the bucket is full again; on a refusal, until a request is allowed (as Retry-After).

201 success

Account created, invitation accepted, signed in.

As application/json.

Set-Cookie header

The session cookie.

organizationobjectalways present

The organization, by id and name.

organization.idstring (uuid)always present

The organization joined. Send it as X-DTG-Org to act in it.

organization.namestringalways present

The organization's name.

membership_idstring (uuid)always present

The new (or re-activated) membership's id.

role"member" | "admin"always present

The role the invitation carried.

seatedbooleanalways present

True when a seat was taken. An admin is always seated; a member is seated only when a seat was free, else joins as a free member.

400 error

Bad request. Codes: captcha_missing (no human-check token; errors repeats it), bad_request (token, name (1 to 120 characters), password or marketing_opt_in missing or of the wrong type), password_too_short (carries min_length), password_too_long (carries max_length), malformed_json (the body is not valid JSON).

As application/problem+json.

403 error

Forbidden. Codes: captcha_failed (the human check did not pass).

As application/problem+json.

404 error

Not found. Codes: not_found (the token is not an open invitation).

As application/problem+json.

409 error

Conflict. Codes: account_exists (the address already has an account; sign in and accept the invitation).

As application/problem+json.

410 error

Gone. Codes: invite_expired (carries expired_at and lifetime_days).

As application/problem+json.

413 error

Payload too large. Codes: body_too_large (over 4 KB; carries limit_bytes).

As application/problem+json.

429 error

rate_limited (the per-minute ceiling, X-RateLimit-* say which), points_exhausted (the monthly points allowance; Retry-After to the end of the UTC month), server_busy or sandbox_busy (load; retry after Retry-After). A refused server_busy request is not metered.

As application/problem+json.

Retry-After header

Seconds to wait before retrying.

X-RateLimit-Limit header

The per-minute request ceiling that applies.

X-RateLimit-Remaining header

Requests left in the current window.

X-RateLimit-Reset header

Seconds until the window refills: on every answer, the time until the bucket is full again; on a refusal, until a request is allowed (as Retry-After).

503 error

Service unavailable. Codes: unavailable (the human-check service could not be reached; retry).

As application/problem+json.

200 success

The pending requests.

As application/json.

dataarray of OrgJoinRequestalways present

Pending requests, oldest first.

data[].idstring (uuid)always present

The request's id.

data[].emailstringalways present

The requester's sign-in address.

data[].display_namestring or nullalways present

The requester's display name; null when none.

data[].status"pending"always present

Always pending here.

data[].created_atstring (date-time)always present

When the request was made (or last re-made).

401 error

Unauthorized. Codes: unauthenticated (no credential, or the key or session is not valid); key_revoked (an API key that was revoked: revoked_at, and reason -- holder, admin, member_removed, seat_removed, api_disabled, addon_ended, account_closed, org_closed, retired, or null for a key revoked before T110 -- and a sentence saying when and why).

As application/problem+json.

403 error

Forbidden. Codes: no_membership, account_suspended, org_suspended, org_closed, wrong_instance (see GET /v2/account/members; base_url names the address that serves the key).

As application/problem+json.

404 error

Not found. Codes: not_found (X-DTG-Org names an organization the caller is not an active member of).

As application/problem+json.

429 error

rate_limited (the per-minute ceiling, X-RateLimit-* say which), points_exhausted (the monthly points allowance; Retry-After to the end of the UTC month), server_busy or sandbox_busy (load; retry after Retry-After). A refused server_busy request is not metered.

As application/problem+json.

Retry-After header

Seconds to wait before retrying.

X-RateLimit-Limit header

The per-minute request ceiling that applies.

X-RateLimit-Remaining header

Requests left in the current window.

X-RateLimit-Reset header

Seconds until the window refills: on every answer, the time until the bucket is full again; on a refusal, until a request is allowed (as Retry-After).

200 success

Approved; the membership was created or re-activated.

As application/json.

idstring (uuid)always present

The request's id.

status"approved" | "denied"always present

The decision.

membership_idstring (uuid)

Approve only: the new (or re-activated) membership's id.

seatedboolean

Approve only: true when a seat was taken (always for an admin; for a member only when one was free).

rejoinedboolean

Approve only: true when a former membership was re-activated rather than created.

401 error

Unauthorized. Codes: unauthenticated (no credential, or the key or session is not valid); key_revoked (an API key that was revoked: revoked_at, and reason -- holder, admin, member_removed, seat_removed, api_disabled, addon_ended, account_closed, org_closed, retired, or null for a key revoked before T110 -- and a sentence saying when and why).

As application/problem+json.

403 error

Forbidden. Codes: role_required (the caller is a member; carries required), no_membership, account_suspended, org_suspended, org_closed, wrong_instance (see GET /v2/account/members; base_url names the address that serves the key). A sandbox key: sandbox_read_only (it may write only clusters).

As application/problem+json.

404 error

Not found. Codes: not_found (no pending request with that id here, or X-DTG-Org names an organization the caller is not an active member of).

As application/problem+json.

429 error

rate_limited (the per-minute ceiling, X-RateLimit-* say which), points_exhausted (the monthly points allowance; Retry-After to the end of the UTC month), server_busy or sandbox_busy (load; retry after Retry-After). A refused server_busy request is not metered.

As application/problem+json.

Retry-After header

Seconds to wait before retrying.

X-RateLimit-Limit header

The per-minute request ceiling that applies.

X-RateLimit-Remaining header

Requests left in the current window.

X-RateLimit-Reset header

Seconds until the window refills: on every answer, the time until the bucket is full again; on a refusal, until a request is allowed (as Retry-After).

200 success

Denied.

As application/json.

idstring (uuid)always present

The request's id.

status"approved" | "denied"always present

The decision.

membership_idstring (uuid)

Approve only: the new (or re-activated) membership's id.

seatedboolean

Approve only: true when a seat was taken (always for an admin; for a member only when one was free).

rejoinedboolean

Approve only: true when a former membership was re-activated rather than created.

401 error

Unauthorized. Codes: unauthenticated (no credential, or the key or session is not valid); key_revoked (an API key that was revoked: revoked_at, and reason -- holder, admin, member_removed, seat_removed, api_disabled, addon_ended, account_closed, org_closed, retired, or null for a key revoked before T110 -- and a sentence saying when and why).

As application/problem+json.

403 error

Forbidden. Codes: role_required (the caller is a member; carries required), no_membership, account_suspended, org_suspended, org_closed, wrong_instance (see GET /v2/account/members; base_url names the address that serves the key). A sandbox key: sandbox_read_only (it may write only clusters).

As application/problem+json.

404 error

Not found. Codes: not_found (no pending request with that id here, or X-DTG-Org names an organization the caller is not an active member of).

As application/problem+json.

429 error

rate_limited (the per-minute ceiling, X-RateLimit-* say which), points_exhausted (the monthly points allowance; Retry-After to the end of the UTC month), server_busy or sandbox_busy (load; retry after Retry-After). A refused server_busy request is not metered.

As application/problem+json.

Retry-After header

Seconds to wait before retrying.

X-RateLimit-Limit header

The per-minute request ceiling that applies.

X-RateLimit-Remaining header

Requests left in the current window.

X-RateLimit-Reset header

Seconds until the window refills: on every answer, the time until the bucket is full again; on a refusal, until a request is allowed (as Retry-After).