The members of the carrier and the invitations still open.
List the invitations
Carrier admins only. Invitations neither accepted nor revoked, newest first, cursor paginated.
query Parameters
limitMaximum number of items in the page.
cursorThe next_cursor of the previous page, passed back as is. Omit it to get the first page.
statusComma-separated statuses to keep. Accepted and revoked invitations are never listed.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
List the invitations › Responses
One page of invitations.
next_cursorPass it as cursor to get the next page. null on the last page.
List the team
Carrier admins and dispatchers (who pair the phones of the drivers). Newest first, cursor paginated: pass next_cursor back as cursor to get the next page. counts covers the whole team, whatever the filter and the page.
query Parameters
limitMaximum number of items in the page.
cursorThe next_cursor of the previous page, passed back as is. Omit it to get the first page.
roleComma-separated roles to keep.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
List the team › Responses
One page of members.
next_cursorPass it as cursor to get the next page. null on the last page.
Totals of the whole team, whatever the filter and the page.
Change the role or the status of a member
Carrier admins only. An admin may not disable or demote their own membership (403), a shipper membership keeps its role (403), and a person cannot get a role they already hold (409).
path Parameters
membership_idThe membership_id of the member.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Change the role or the status of a member › Request Body
rolestatusChange the role or the status of a member › Responses
The updated member.
membership_iduser_idfull_nameemailroleThe account a shipper is limited to; null for the other roles.
statussecond_factornull while the identity provider does not report it.
last_active_at^(?:(?:\d\d[2468][04… · requiredLast time the member was seen, when known.
created_at^(?:(?:\d\d[2468][04… · requiredSend an invitation again
Carrier admins only. Emails a new link valid 7 days; the previous link stops working. An accepted or revoked invitation gives not_found.
path Parameters
idThe invitation id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Send an invitation again › Responses
The invitation with its new expiry.
idemailroleshipper_account_idexpires_at^(?:(?:\d\d[2468][04… · requiredcreated_at^(?:(?:\d\d[2468][04… · requiredaccept_urlThe accept link, only in the response that minted the token and only on a stage that sends no invitation email (demo). Elsewhere the email is the only copy.
Revoke an invitation
Carrier admins only. Its link stops working. An accepted or revoked invitation gives not_found.
path Parameters
idThe invitation id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Revoke an invitation › Responses
Done.