v1

latestSwagger 2.02026-08-063530171.1 KB
teams

Retrieve a Team

Required fields are name and subdomain where the subdomain is globally unique. Use POST to create a Team. To update a field on a Team use PATCH.

To use the API on behalf of a particular team change the endpoint to: https://{{ subdomain }}.signrequest.com/api/v1/...

To invite new team members you can use POST {"email":"email-of-member-to-invite@example.com","is_admin":false,"is_owner":false} to: https://signrequest.com/api/v1/teams/**{{ subdomain }}**/invite_member/

get/teams/{subdomain}/

Response

OK

namestring required
subdomainstring slug required
urlstring uri
logostring uri nullable
phonestring
primary_colorstring
events_callback_urlstring uri nullable
documents_as_attachmentsboolean nullable
delete_afterstring date-time nullable

When filled this team will be deleted after this date

sandboxboolean

Indicates whether team is in Sandbox mode