Team
Endpoints
The team object
Attributes
-
id stringUnique identifier of the team.
-
name stringThe team name.
-
active stringWhether or not this team is active: true for active, false for disabled.
-
created stringUnix timestamp for when the team was created.
-
updated stringUnix timestamp for when the team was updated.
-
type stringThe type of team:
-
members array[object]Array of user objects in this team with their attributes.
Example in response here:
{
"id": "d94cfb24fa04bf2f564a943921b302c6cadfbd4e",
"name": "New team",
"active": true
"created": "1534928514",
"updated": "",
"type": "VIEWABLE",
"members": [
{
"id": "5a81a4ecc895e6ceab5aa0b090747745a6339b95",
"emails": [
"member1@signnow.com"
],
"role": "member",
"status": "accepted",
"can_admin_view": true
},
{
"id": "caf31778ef8e4efdaa86e4e91067397f02d66508",
"emails": [
"admin@signnow.com"
],
"role": "admin",
"status": "accepted",
"primary": false,
"billing": 1,
"document_access": 1,
"can_admin_view": false
},
{
"id": "79c7ec6b258346105e415ceae13b687c4231966b",
"emails": [
"admin2@signnow.com"
],
"role": "admin",
"status": "accepted",
"primary": true,
"billing": 1,
"document_access": 1,
"can_admin_view": false
},
{
"id": "d4943d8c8814667018060c79c760c8acfc870d3a",
"emails": [
"member2@signnow.com"
],
"role": "member",
"status": "pending",
"can_admin_view": false
}
}
}
Create a team
Parameters
-
name requiredName of a new team. Any text up to 40 characters (but it's not allowed to use special symbols without letters or numbers)
-
type optionalType of a team. Possible values: VIEWABLE, SHAREABLE. If this parameter isn't specified, default value is VIEWABLE.
Returns
- Value of the “name” parameter is not a string
- There is no “name” parameter in the payload or it consists of special characters only
- Type of the team is invalid
POST /team
curl
-X POST
\
' https://api-eval.signnow.com/team'
\
-H
'Authorization:
Bearer {{access_token}}'
\
-H
'Content-type:
application/json'
\
-d {'
"name"
"New Team"
,
"type"
"VIEWABLE"
,
}'
Response
{
"id": "e2775934eeb60b452023d7c6a8ae1f720dc6c48d"
}
Accept or decline invitation to a team
Parameters
-
request_id requiredPath parameter: ID of the request to join a team. Can be found in the response to POST /team/{{team_id}}
-
accept requiredBoolean: true - the user accepts the invite, false - the user declines the invite.
Returns
- User accepts/denies invite which is not pending
- User’s Organization settings restricts them from joining this team
- "accept" body parameter contains invalid value
- User declines an invite which has status “accepted”
- User accepts/declines invite which doesn't belong to them
- Request_id doesn't exists in signNow database
- Request_id doesn't correspond to 40 characters length
PUT /team/{{request_id}}/request
curl
-X PUT
\
' https://api-eval.signnow.com/team/{{request_id}}/request'
\
-H
'Authorization:
Bearer {{access_token}}'
\
-d '{
"accept":
true
}
Response
{
"result": "success"
}
Get team invite
Parameters
-
request_id requiredPath parameter: ID of the request to join a team. Can be found in the response to POST /team/{{team_id}}
Returns
- User is trying to get someone else’s team invite
- Request_id is invalid
GET /team/{{request_id}}/request
curl
-X GET
\
' https://api-eval.signnow.com/team/{{request_id}}/request'
\
-H
'Authorization:
Bearer {{access_token}}'
\
Response
{
"team_name":"Cool Team Name",
"team_id":"d4943d8c8814667018060c79c760c8acfc870d3a",
"request_id":"79c7ec6b258346105e415ceae13b687c4231966b",
"request_status":"waiting"
}
Rename team
Parameters
-
team_id requiredPath parameter: ID of the requested team.
-
name requiredNew name for the team.
Returns
PUT /team/{{team_id}}
curl
-X PUT
\
' https://api-eval.signnow.com/team/{{team_id}}'
\
-H
'Authorization:
Bearer {{access_token}}'
\
-d '{
"name":
"New team name"
}'
Response
{
"id": "960396a6d502e03743c7bd5da0e396bb61d582d2"
}
Get team
Parameters
-
team_id requiredPath parameter: ID of the requested team.
Returns
- Either incorrect or expired token is provided in the header
- User who makes the request is not a member of the requested team
- Team is inactive
GET /team/{{team_id}}
curl
-X GET
\
' https://api-eval.signnow.com/team/{{team_id}}'
\
-H
'Authorization:
Bearer {{access_token}}'
\
Response
{
"id": "d94cfb24fa04bf2f564a943921b302c6cadfbd4e",
"name": "New team",
"active": true
"created": "1534928514",
"updated": "",
"type": "VIEWABLE",
"members": [
{
"id": "5a81a4ecc895e6ceab5aa0b090747745a6339b95",
"emails": [
"member1@signnow.com"
],
"role": "member",
"status": "accepted",
"can_admin_view": true
},
{
"id": "caf31778ef8e4efdaa86e4e91067397f02d66508",
"emails": [
"admin@signnow.com"
],
"role": "admin",
"status": "accepted",
"primary": false,
"billing": 1,
"document_access": 1,
"can_admin_view": false
},
{
"id": "79c7ec6b258346105e415ceae13b687c4231966b",
"emails": [
"admin2@signnow.com"
],
"role": "admin",
"status": "accepted",
"primary": true,
"billing": 1,
"document_access": 1,
"can_admin_view": false
},
{
"id": "d4943d8c8814667018060c79c760c8acfc870d3a",
"emails": [
"member2@signnow.com"
],
"role": "member",
"status": "pending",
"can_admin_view": false
}
}
}
Delete team
Parameters
-
team_id requiredPath parameter: ID of the requested team.
Returns
- User who is not the primary admin tries to delete a team
- Team is inactive
DELETE /team/{{team_id}}
curl
-X DELETE
\
' https://api-eval.signnow.com/team/{{team_id}}'
\
-H
'Authorization:
Bearer {{access_token}}'
\
Response
{
"result": "success",
}
Grant admin permissions
Parameters
-
team_id requiredPath parameter: ID of the requested team.
-
email requiredEmail address of the user who gets admin permissions.
Returns
- User is not a team admin
- User with provided email is not a team member
- Request without body OR body doesn’t have a valid email address
- team_id is invalid
- User with provided email address doesn’t exist
POST /team/{{team_id}}/admin
curl
-X POST
\
'https://api-eval.signnow.com/team/{{team_id}}/admin'
\
-H
'Authorization:
Bearer {{access_token}}'
\
-d '{
"email":
"admin1@signow.com"
}'
Response
{
"result": "success"
}
Disable admin permissions
Parameters
-
team_id requiredPath parameter: ID of the requested team.
-
user_id requiredPath parameter: ID of the user disable admin permissions for.
Returns
- User is not a team admin
- Team admin cannot delete primary admin.
- Incorrect user_id. User is not a team admin.
- Admin is trying to delete their own admin permissions
- team_id is invalid
- User with provided user_id doesn’t exist
DELETE /team/{{team_id}}/admin/{{user_id}}
curl
-X DELETE
\
'https://api-eval.signnow.com/team/{{team_id}}/admin/{{user_id}}'
\
-H
'Authorization:
Bearer {{access_token}}'
\
Response
{
"result": "success"
}
Share doc group template
Parameters
-
team_id requiredPath parameter: ID of the requested team.
-
doc_group_id requiredPath parameter: ID of the requested document group.
Returns
- User is not a team member
- User is not an owner of document group template
- Document Group ID is invalid
- Team_id is invalid
POST /team/{{team_id}}/documentgroup/template/{{doc_group_id}}/share
curl
-X POST
\
' https://api-eval.signnow.com/team/{{team_id}}/documentgroup/template/{{doc_group_id}}/share'
\
-H
'Authorization:
Bearer {{access_token}}'
\
Response
{
"result": "success"
}
Delete doc group template
Parameters
-
team_id requiredPath parameter: ID of the requested team.
-
doc_group_id requiredPath parameter: ID of the requested document group.
Returns
- User is not a team member
- User is not an owner of document group template
- Document Group ID is invalid
- Team_id is invalid
DELETE /team/{{team_id}}/documentgroup/template/{{doc_group_id}}/share
curl
-X DELETE
\
' https://api-eval.signnow.com/team/{{team_id}}/documentgroup/template/{{doc_group_id}}/share'
\
-H
'Authorization:
Bearer {{access_token}}'
\
Response
{
"result": "success"
}
Get team document group templates
Parameters
-
team_id requiredPath parameter: ID of the requested team.
-
limit requiredQuery parameter: limit for the search results. Accepts values from 1 to 50.
-
offset optionalQuery parameter. Accepts positive numbers starting from 0.
Returns
- User is not a team member
- Value of the “limit” parameter is missing or invalid
- Offset parameter is invalid
- team_id is invalid
GET /team/{{team_id}}/documentgroup/templates
curl
-X GET
\
' https://api-eval.signnow.com/team/{{team_id}}/documentgroup/templates?limit=10&offset=0'
\
-H
'Authorization:
Bearer {{access_token}}'
\
Response
{
"document_group_templates": [
{
"last_updated": "1534146166",
"template_group_id": "23b60dd3451d2f86a527970db7875f57712a333c",
"template_group_name": "template 2",
"owner_email": "email@signow.com",
"templates": [
{
"id": "bc07f1b0484f112ed077a1862ac355fb8fe51c41",
"name": "Document 1234567",
"thumbnail":
{
"small": "http://api.vm.signnow.com/document/bc07f1b0484f112ed077a1862ac355fb8fe51c41/thumbnail?size=small",
"medium": "http://api.vm.signnow.com/document/bc07f1b0484f112ed077a1862ac355fb8fe51c41/thumbnail?size=medium",
"large": "http://api.vm.signnow.com/document/bc07f1b0484f112ed077a1862ac355fb8fe51c41/thumbnail?size=large"
},
"roles": [
"Signer 1"
]
},
{
"id": "efefc593d92d7fdd70d5c36282744dd184d46f64",
"name": "Template with fixed role and field",
"thumbnail":
{
"small": "http://api.vm.signnow.com/document/efefc593d92d7fdd70d5c36282744dd184d46f64/thumbnail?size=small",
"medium": "http://api.vm.signnow.com/document/efefc593d92d7fdd70d5c36282744dd184d46f64/thumbnail?size=medium",
"large": "http://api.vm.signnow.com/document/efefc593d92d7fdd70d5c36282744dd184d46f64/thumbnail?size=large"
},
"roles": [
"Signer 1"
]
},
]
}
]
}
Invite a user to a team
Parameters
-
team_id requiredPath parameter: ID of the requested team
Returns
- User is not a team member
- Request without body OR Body is not a valid JSON
- One or more value in the “emails” array is invalid (not an email address)
- Invalid team_id
POST /team/{{team_id}}/request
curl
-X POST
\
' https://api-eval.signnow.com/team/{{team_id}}/request'
\
-H
'Authorization:
Bearer {{access_token}}'
\
-H
'Content-type:
application/json'
\
-d {'
"emails": [
"test1@signnow.com"
,
"test2@signnow.com"
,
"test3@signnow.com"
,
]
}'
Response
{
"team_requests": [
{
"email": "test1@signnow.com",
"status": "success",
"id": "dfeff91afc7bf73927d9ba2b8d9a52843c1878be"
}
{
"email": "test2@signnow.com",
"status": "success",
"id": "0e8663aae56cc07a4b8abce55c687381a67802a5"
}
{
"email": "test3@signnow.com",
"status": "success",
"id": "d4707d2e40fc06f39c8a3047c88464d10099e561"
}
]
}
Enable Documents folder
Parameters
-
team_id requiredPath parameter: ID of the requested team.
Returns
- User is not team primary admin or admin
- Team_id is invalid
POST /team/{{team_id}}/shared/document/folder
curl
-X POST
\
' https://api-eval.signnow.com/team/{{team_id}}/shared/document/folder'
\
-H
'Authorization:
Bearer {{access_token}}'
\
Response
{
"id": "1893180697eb9bc2965f5e1b5a502a0942718d04"
}
Disable Documents folder
Parameters
-
team_id requiredPath parameter: ID of the requested team.
Returns
- User is not team primary admin or admin
- Team_id is invalid
DELETE /team/{{team_id}}/shared/document/folder
curl
-X DELETE
\
' https://api-eval.signnow.com/team/{{team_id}}/shared/document/folder'
\
-H
'Authorization:
Bearer {{access_token}}'
\
Response
{
"result": "success"
}
Change team primary admin
Parameters
-
team_id requiredPath parameter: ID of the requested team.
-
user_id requiredPath parameter: ID of the new team primary admin.
Returns
- a user who makes the request is not a primary admin of the given team
- provided {{user_id}} is not of a team member
POST /team/{{team_id}}/transferownership/{{user_id}}
curl
-X POST
\
' https://api-eval.signnow.com/team/{{team_id}}/transferownership/{{user_id}}'
\
-H
'Authorization:
Bearer {{access_token}}'
\
Response
{
"result": "success"
}
Get user's teams
No parameters required.
Returns
GET /v2/teams
curl
-X GET
\
' https://api-eval.signnow.com/v2/teams'
\
-H
'Authorization:
Bearer {{access_token}}'
\
Response
{
"data": [
{
"id": "e87f5fcf97e74e81a97738b2bf25195fa90d1e6d",
"active": 1,
"name": "Handcrafted Metal Cheese",
"created": 1573658889,
"type": "VIEWABLE",
"role": "admin"
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 15,
"current_page": 1,
"total_pages": 1,
"links": []
}
}
}
Get team admins
Parameters
-
team_id requiredPath parameter: ID of the requested team.
Returns
- Either incorrect or expired token is provided in the header
- User who makes the request is not a member of the requested team
- Team is inactive
GET /v2/team/{{team_id}}/admins
curl
-X GET
\
' https://api-eval.signnow.com/v2/teams/{{team_id}}/admins'
\
-H
'Authorization:
Bearer {{access_token}}'
\
Response
{
"data": [
{
"user_id": "e13b50f63fd5492499b0ed346a3a3db6d045ca37",
"email": "admin@signnow.com",
"type": 1,
"primary": true,
"updated": 1573645752,
"created": 1573645637
}
]
}
Delete user from a team
- team primary admin to delete a user from a team
- team members to delete themselves from a team
Parameters
-
team_id requiredPath parameter: ID of the requested team.
-
user_id requiredPath parameter: ID of the user to delete.
Returns
- Incorrect access_token. access_token must belong to team primary admin or the user being deleted
- Invalid team_id. Team with the provided ID doesn’t exist.
- Invalid user_id. User with the provided ID doesn’t exist.
DELETE /team/{{team_id}}/user/{{user_id}}
curl
-X DELETE
\
'https://api-eval.signnow.com/team/{{team_id}}/user/{{user_id}}'
\
-H
'Authorization:
Bearer {{access_token}}'
\
Response
{
"result": "success"
}