Organizations

Organization - a signNow entity which has a unique ID, logo, documents and templates, an Admin, Moderators, Teams, and Members.

The Organizations functionality helps manage multiple users and their document workflows: add custom branding to the documents for signature, share document templates, track user’s activity etc.

Organizations users can have multiple access levels: Admin (former Super Admin), Moderator (former Admin), or Member. An Organization should consist of at least one Admin and can be active without members at all.

Users can see current membership status in the Current Membership section. Admins/Moderators see the list of Organizations they are admins of in the Managed Organizations section with info about them (name, logo, user membership).

Admin is the highest level of management in the Organization. Admins assign (and change) the following roles to the users: Admin, Moderator, or Member. Admins and Moderators can join the Organization as a Member or cancel their membership. They can also cancel Admin and Moderator rights in Organizations, however, the last Admin of the organization has to contact support to transfer his Management rights before he leaves the organization.

Moderator can assign (and change) the following roles to the users: Moderator, Member. Moderators can remove moderators and members from the organization and leave the organization themselves.

All the Organization settings are applied to a Member's account, however, a Member does not influence the Organization's setup in any way. A user can be a Member of only one Organization. In case a user becomes a Member of another Organization, they get a notification about canceling current membership and starting a new one when they are joining a new Organization as a Member.

A Member, Moderator, and Admin can cancel their Membership in the Organization without contacting support.

See more: Organizations

Endpoints

The Organization object

Attributes

Various attributes of the Organization object are available by different endpoints:

Here is a description of general attributes of the Organization object:

  • id string
    Unique identifier for the object.
  • name string
    The name of the organization.
  • active array[object]
    Whether the organization is active.
  • has_admin string
    Whether the organization has an admin.
  • logo string
    Whether there is an organization logo.
  • membership array[object]
    List of members by access types
  • type string
    (Inside "membership" array) The member's access type: admin, moderator, or member.
  • status string
    (Inside "membership" array) Active or deactivated member.
  • invited_by array[string]
    (Inside "membership" array) If invited by the other member, data about the member who was inviting.
  • id string
    (Inside "invited_by" array) User id of the member who invited the other member.
  • email string
    (Inside "invited_by" array)Email address of the member who invited the other member.
The Organization object
                { 
              
                  "id": "960c8d6e24314f0d86118f128b3284d2bb36cb00", 
              
                  "name": "Test Organization",
              
                  "active": true, 
              
                  "logo": null, 
              
                  "membership": { 
              
                    "type": "admin", 
              
                    "status": "active", 
              
                    "invited_by": { 
              
                      "id": "9c4bd7cfafbe481da5556416480774d2f6eb9ex0", 
              
                      "email": "signnow_user@signnow.com" 
              
                    } 
              
                  } 
              
                } 
              

Create organization

Creates an Organization. The user who created the organization - automatically becomes the admin(old - super admin) of this organization

Parameters
  • name required
    Name of the organization. Max length: 255 chars.
Returns

Returns the id of the created organization in case of successful response. Returns an error when:

  • If user with a trial sub tries to create more than 5 organizations or If user with Professional or Enterprise subscription tries to create more than 50 organizationsIf user with Professional or Enterprise subscription tries to create more than 50 organizations, "code": 12001006. Message: "The number of created organizations has been exceeded."
  • If user who does not have Trial, Professional or Enterprise subscription tries to create an organization, "code": 12003002. Message: "Access denied for current subscription."
  • Request without mandatory parameters, "code": 12001002. Message: "The `name` field is required."
  • Request with name more than 255 chars length, "code": 12001004. Message: "The `name` field length must be less than 255 characters."
  • Request with invalid format of name parameter value, "code": 12001003. Message: "The `name` field must be a string."
POST /v2/organizations
cURL
                      
curl -X POST \          
  https://api-eval.signnow.com/v2/organizations \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \       
  -d '{
  "name": "Test ORG"
  } 
                      
                    
Response
                {
    "id": "1afee427a35e404e9eb6f98cb6586f5e3ccef0a2"
}
                
              

Rename organization

Renames an Organization.

Parameters
  • org_id required
    Path parameter: id of the organization that is being renamed.
  • name required
    Name of the organization. Max length: 255 chars.
Returns

Returns the id of the created organization in case of successful response. Returns an error when:

  • If user who is not the superadmin of org tries to change name of org or user is not related to org at all, "code": 12003001. Message: "Access denied."
  • If user tries to change org with expired trial, professional or enterprise subs or has another (not trial, professional or enterprise) type of subscription, "code": 12003002. Message: "Access denied for current subscription."
  • if user tries to change deleted org or org, "code": 12003001. Message: "Organization `6308476d375549098254f223dbd1721873e046cb` is not found."
  • If user who is not the superadmin tries to change org name, "code": 12003003. Message: "Access denied for current administration role in your organization."
  • Request without mandatory parameters, "code": 12001002. Message: "The `name` field is required."
  • Request with name more than 255 chars length, "code": 12001004. Message: "The `name` field length must be less than 255 characters."
  • Request with invalid format of name parameter value, "code": 12001003. Message: "The `name` field must be a string."
PUT /v2/organizations/{{org_id}}
cURL
                      
curl -X PUT \          
  https://api-eval.signnow.com/v2/organizations/{{org_id}} \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \       
  -d '{
  "name": "Test ORG"
  } 
                      
                    
Response 204
                {
    No content
}
                
              

Get admin's organizations

Retrieves a list of organizations in which the user has the role of moderator/admin.

Parameters
  • per_pageoptional
    Query parameter. Allowed values: positive integers from 1 to 100.
  • page optional
    Query parameter. Allowed values: any positive integer starting from 1.
  • filter:status optional
    Query parameter. Possible values: active, pending. Format: ?filters=[{"status":{"type": "=", "value":"active|pending"}}]
  • filter:type optional
    Query parameter. Possible values: member/admin/moderator. Format: ?filters=[{"type":{"type": "in", "value":["member|admin|moderator"]}}]
Returns

Returns the list of organization objects in case of successful response. Returns an error when:

  • Request with invalid format of parameters (page, per_page), "code": 12006001. Message: "Query parameter `per_page` must be a digit"; 12006003 - "Query parameter `per_page` must be less than or equal 100"; 12006004 - "Query parameter `page` must be a digit".
GET /v2/organizations
cURL
                      
curl -X GET \          
  https://api-eval.signnow.com/v2/organizations \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \        
                      
                    
Response 204
                {
    "data": [
        {
            "id": "960c8d6e24314f0d86118f128b3284d2bb36cb00",
            "name": "Test",
            "active": boolean,
            "logo": null,
            "membership": {
                "type": "admin",
                "status": "active"
                "invited_by": {
               "id": "user_unique_id",
               "email": "test@signnow.com"
           }
            }
        }
    ],
    "meta": {
        "pagination": {
            "total": 22,
            "count": 1,
            "per_page": 1,
            "current_page": 1,
            "total_pages": 22,
            "links": {
                "next": "http://team.signnow-dev.int/v2/organizations?page=2"
            }
        }
    }
}
                
              

Delete organization

Deletes an organization.

Parameters
  • org_id required
    Path parameter. id of the organization that is being deleted.
Returns

Returns empty 204 in case of successful response. Returns an error when:

  • If organization is not active, "code": 12003001. Message: "Organization `475fe6e7894344e0ad200bc3442d022792b3b7e0` is not found."
  • If user who is not admin of org tries to delete it, "code": 12003003. Message: "Access denied for current administration role in your organization."
DELETE /v2/organizations/{{org_id}}
cURL
                      
curl -X DELETE \          
  https://api-eval.signnow.com/v2/organizations/{{org_id}} \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \        
                      
                    
Response 204
                {
    No content
}
                
              

Get admin's organizations

Retrieves a list of moderators and admins of an organization.

Parameters
  • org_id required
    Path parameter. id of the organization that is being deleted.
  • filters:email optional
    Query parameter. Filter by email. Format: ?filters=[{"email":{"type": "=", "value": user_email}}] (email should be encoded as url)
  • filter:type optional
    Query parameter. Filter by organization type. Possible values: active, pending, declined. Format: ?filters=[{"status":{"type": "=", "value":"active/pending/declined"}}]
  • filter:type optional
    Query parameter. Possible values: admin/moderator. Format: ?filters=[{"type":{"type": "in", "value":["admin|moderator"]}}]
Returns

Returns the list of organization objects in case of successful response. Returns an error when:

  • If user does not have active trial professional or enterprise subscription, "code": 12003002. Message: "Access denied for current subscription."
  • If user is not the moderator or admin of organization, "code": 12003003. Message: "Access denied for current administration role in your organization."
  • If org is not active or does not exist at all, "code": 12003001. Message: "Organization `92461306fce94a868eebd9dec641f0b4f58694fb` is not found."
  • Request with invalid filter value or format, "code": 12006006. Message: "Unsupported filter mail was given."; 12004018 - "The `email` filter value should be of type string"; 12004017 - "The `email` filter expression should be equal to `=`"; 12004019 - "Invalid filter format, filter must have `type` and `value` fields".
GET /v2/organizations/{{org_id}}/admins
cURL
                      
curl -X GET \          
  https://api-eval.signnow.com/v2/organizations/{{org_id}}/admins \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \        
                      
                    
Response 204
                {
    "data": [
        {
            "id": "37a95ec9e51d4b168c74ffc23f6089b04ed679ff",
            "email": "asdfhshhs@email.com",
            "type": "admin",
            "status": "active"
        },
        {
            "id": "7d0083222c04fe245152739f977bf9f4741659b2",
            "email": "org_owner@email.com",
            "type": "moderator",
            "status": "pending"
        }
    ],
    "meta": {
        "pagination": {
            "total": 2,
            "count": 2,
            "per_page": 15,
            "current_page": 1,
            "total_pages": 1,
            "links": []
        }
    }
}
                
              

Add moderator or admin

Adds admin or moderator to organization

Parameters
  • org_id required
    Path parameter. id of the organization that is being deleted.
  • email required
    Email of the user invited
  • type required
    User's type of access in the organization. Possible values: moderator, admin.
Returns

Returns id of the invitation to become moderator/admin in case of successful response. Returns an error when:

  • If moderator tries to add admin to org, "code": 12004007. Message: "Access denied."
  • If user who is not the admin or moderator tries to add admin or moderator to org or admin or moderator with pending status tries to add admin or moderator to org, "code": 12003003. Message: "Access denied for current administration role in your organization."
  • If user who does not have appropriate subscription tries to add admins or moderators to org, "code": 12003002. Message: "Access denied for current asubscription."
  • If user tries to add admin or moderator who already exists in org, "code": 12004009. Message: "Organization admin exists."
  • If user tries to add admin or moderator who is not registered in signNow, "code": 12004008. Message: "User `test-user@gmail.com` is not found."
  • If org is not active or does not exist at all, "code": 12003001. Message: "Organization `92461306fce94a868eebd9dec641f0b4f58694fb` is not found."
  • Request without mandatory parameters, "code": 12004001. Message: "The `email` field is required."; 12004003 - "The `type` field is required.";
  • Request with invalid value of type parameter, "code": 12004005. Message: "The `type` should be equal to `moderator` or admin."
  • Request with invalid value of email parameter, "code": 12004006. Message: "The `email` is invalid."
POST /v2/organizations/{{org_id}}/admins
cURL
                      
curl -X POST \          
  https://api-eval.signnow.com/v2/organizations/{{org_id}}/admins \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \ 
  -d '{
  "email": "new_user@gmail.com",
  "type": "moderator | admin"
  } 
                      
                    
Response 204
                {
    "data": {
        "id": "b593491c17154c55ad509ac06944499538fdab35",
        "email": "signnowqas+33@gmail.com",
        "type": "moderator | admin ",
        "status": "pending"
    }
}
                
              

Change admin/moderator role

Allows users to manage the admin or moderator role of another user.

Parameters
  • org_id required
    Path parameter. ID of the organization where the role is changed.
  • user_id required
    Path parameter. ID of the user whose role is changed.
  • type required
    The type of role ithat is assigned. Possible values: moderator, admin.
Returns

Returns 204: No content in case of successful response. Returns an error when:

  • If moderator tries to add admin to org, "code": 12004007. Message: "Access denied."
  • If user tries to add admin or moderator to the organization that is not active or does not exist, "code": 12001001. Message: "Organization `de876e793c604dadb99840edc01110d20012dc7a` is not found."
  • The `type` should be equal to `moderator` or admin., "code": 12004012. Message: "The `type` should be equal to `moderator` or admin."
  • The `type` field is required, "code": 12004010. Message: "The `type` field is required."
  • When moderator tries to change type for admin, "code": 12003003. Message: "Access denied for current administration role in your organization."
PUT /v2/organizations/{{org_id}}/admins/{{user_id}}
cURL
                      
curl -X PUT \          
  https://api-eval.signnow.com/v2/organizations/{{org_id}}/admins/{{user_id}} \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \ 
  -d '{
  "type": "moderator | admin"
  } 
                      
                    
Response 204
                {
    No content
}
                
              

Accept/decline invite to be admin

Allows users to accept or decline the invitation to become an admin or moderator.

Parameters
  • org_id required
    Path parameter. ID of the organization where the role is changed.
  • user_id required
    Path parameter. ID of the user whose role is changed.
Returns

Returns 204: No content in case of successful response. Returns an error when:

  • If one user attempts to accept another user's invite, "code": 12007012. Message: "Access denied to accept invite."
  • If there is no invite to accept, "code": 12007013. Message: "Organization invite is not found."
  • If there is no such organization id, "code": 12001001. Message: "Organization `%s` is not found."
  • If there is no such user id, "code": 12005001. Message: "User `534cd85d1bb74774bbbe0cba3f86e20ddcf41034` is not found."
POST /v2/organizations/{{org_id}}/admins/{{user_id}}/accept | decline
cURL
                      
curl -X PUT \          
  https://api-eval.signnow.com/v2/organizations/{{org_id}}/admins/{{user_id}} \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \ 
                      
                    
Response 204
                {
    No content
}
                
              

Remove admin/moderator

Allows users to remove the admin or moderator from the organization.

Parameters
  • org_id required
    Path parameter. ID of the organization where the role is changed.
  • admin_id required
    Path parameter. ID of the user whose role is changed.
Returns

Returns 204: No content in case of successful response. Returns an error when:

  • If admin with expired/without appropriate subscription tries to remove admin, "code": 12003002. Message: "Access denied for current subscription."
  • If last admin tries to remove himself, "code": 12004022. Message: "Can not delete the last admin."
  • If admin tries to remove admin in ‘pending’ status, "code": 12004025. Message: "Organization admin `44ce03758d8844bebc5c3a63900d5f5165ed3373` is not found."
  • If moderator tries to remove admin, "code": 12004023. Message: "Access denied."
  • If the organization is deleted or does not exist, "code": 12001001. Message: "Organization `f20be6d0599f43ba8e1d26caaf717b6d1c6f4cfb` is not found."
  • If admin who remove isn’t a member of the organization, "code": 12003003. Message: "Access denied for current administration role in your organization."
DELETE /v2/organizations/{{org_id}}/admins/{{admin_id}}
cURL
                      
curl -X DELETE \          
  https://api-eval.signnow.com/v2/organizations/{{org_id}}/admins/{{admin_id}} \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \  
                      
                    
Response 204
                {
    No content
}
                
              

Get the list of members

Retrieve all members of the organization.

Parameters
  • org_id required
    Path parameter. ID of the organization where the role is changed.
  • filters:email optional
    Query parameter. Filter by email. Format: ?filters=[{"email":{"type": "=", "value": user_email}}] (email should be encoded as url)
  • filter:type optional
    Query parameter. Filter by organization type. Possible values: active, pending, declined. Format: ?filters=[{"status":{"type": "=", "value":"active/pending/declined"}}]
  • sort:email optional
    Query parameter. Sort results in ascending or descending order. Possible values: asc/desc. Format: ?sort[email]=asc
Returns

Returns the list of organization members in case of successful response. Returns an error when:

  • If user does not have active trial professional or enterprise subscription, "code": 12003002. Message: "Access denied for current subscription."
  • If user is not the moderator or admin of organization, "code": 12003003. Message: "Access denied for current administration role in your organization."
  • If org is not active or does not exist at all, "code": 12003001. Message: "Organization `92461306fce94a868eebd9dec641f0b4f58694fb` is not found."
  • Request with invalid filter value or format, "code": 12006006. Message: "Unsupported filter mail was given."; 12004018 - "The `email` filter value should be of type string"; 12004017 - "The `email` filter expression should be equal to `=`"; 12004019 - "Invalid filter format, filter must have `type` and `value` fields".
GET /v2/organizations/{{org_id}}/members
cURL
                      
curl -X GET \          
  https://api-eval.signnow.com/v2/organizations/{{org_id}}/members \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \  
                      
                    
Response 204
                {
    "data": [
        {
            "id": "d2f2cd05e5964708bf4d6d79a815267baf469a95",
            "email": "signnow.user@email.com",
            "status": "active",
            "last_login": {
                "last_login": 1603199032,
                "ip": "217.20.164.1",
                "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.75 Safari/537.36",
                "application": "SignNow Web Application",
                "created_at": 1592481155
            }
        }
 {
            "id": "af496b9b504f4dc29e20cde5bb08726655b999af",
            "email": "another.signnow.user@email.com",
            "status": "pending",
            "last_login": []
        },
    ],
    "meta": {
        "pagination": {
            "total": 1,
            "count": 1,
            "per_page": 15,
            "current_page": 1,
            "total_pages": 1,
            "links": []
        }
    }
}
                
              

Add members

Adds members to the organization

Parameters
  • org_id required
    Path parameter. id of the organization that is being deleted.
  • email required
    Email of the user invited
Returns

Returns 204: No content in case of successful response. Returns an error when:

  • If user who is not the admin or moderator tries to add member to org or admin or moderator with pending status tries to add a member to org, "code": 12003003. Message: "Access denied for current administration role in your organization."
  • If user who does not have appropriate subscription tries to add a member to org, "code": 12003002. Message: "Access denied for current asubscription."
  • If user tries to add member who already exists in org, "code": 12007005. Message: "Organization user already exists."
  • If user tries to add member who is not registered in signNow, "code": 12005001. Message: "User `test-user@gmail.com` is not found."
  • If org is not active or does not exist at all, "code": 12003001. Message: "Organization `92461306fce94a868eebd9dec641f0b4f58694fb` is not found."
  • Request without mandatory parameters, "code": 12007007. Message: "The `email` field is required."; 12004003 - "The `email` field is required.";
  • Request with invalid value of email parameter, "code": 12007006. Message: "The `email` field must be a string."
  • Request with invalid format of email parameter, "code": 12007008. Message: "The `email` is invalid."
  • Trial admin/moderator tries to invite > 50 active+pending members, "code": 12007034. Message: "The number of active and pending organization members has been exceeded for the current subscription plan."
POST /v2/organizations/{{org_id}}/members
cURL
                      
curl -X POST \          
  https://api-eval.signnow.com/v2/organizations/{{org_id}}/members \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \ 
  -d '{
  "email": "new_user@gmail.com",
  } 
                      
                    
Response 201
                {
    No content
}
                
              

Remove members

Allows users to remove a member from the organization.

Parameters
  • org_id required
    Path parameter. ID of the organization where the member is removed.
  • member_id required
    Path parameter. ID of the member who is removed.
Returns

Returns 204: No content in case of successful response. Returns an error when:

  • If admin with expired/without appropriate subscription tries to remove admin, "code": 12004024. Message: "Access denied for current subscription."
  • If admin tries to remove not org member or deleted member, "code": 12007014. Message: "Organization user is not found."
  • If the organization is deleted or does not exist, "code": 12003001. Message: "Organization `f20be6d0599f43ba8e1d26caaf717b6d1c6f4cfb` is not found."
DELETE /v2/organizations/{{org_id}}/members/{{member_id}}
cURL
                      
curl -X DELETE \          
  https://api-eval.signnow.com/v2/organizations/{{org_id}}/members/{{member_id}} \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \  
                      
                    
Response 204
                {
    No content
}
                
              

Accept invite to organization

Allows users to accept the invitation to join an organization.

Parameters
  • org_id required
    Path parameter. ID of the organization the member is invited to.
  • member_id required
    Path parameter. ID of the member who is invited.
Returns

Returns 201: No content in case of successful response. Returns an error when:

  • If one user attempts to accept another user's invite, "code": 12007012. Message: "Access denied to accept invite."
  • If there is no invite to accept, "code": 12007013. Message: "Organization invite is not found."
  • If there is no such organization id, "code": 12001001. Message: "Organization `%s` is not found."
  • If there is no such user id, "code": 12005001. Message: "User `534cd85d1bb74774bbbe0cba3f86e20ddcf41034` is not found."
POST /v2/organizations/{{org_id}}/members/{{user_id}}/accept
cURL
                      
curl -X POST \          
  https://api-eval.signnow.com/v2/organizations/{{org_id}}/members/{{user_id}}/accept \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \ 
                      
                    
Response 201
                {
    No content
}
                
              

Decline invite to organization

Allows users to decline the invitation to join an organization.

Parameters
  • org_id required
    Path parameter. ID of the organization the member is invited to.
  • member_id required
    Path parameter. ID of the member who is invited.
Returns

Returns 201: No content in case of successful response. Returns an error when:

  • If one user attempts to accept another user's invite, "code": 12007012. Message: "Access denied to decline invite."
  • If there is no invite to accept, "code": 12007013. Message: "Organization invite is not found."
  • If there is no such organization id, "code": 12001001. Message: "Organization `%s` is not found."
  • If there is no such user id, "code": 12005001. Message: "User `534cd85d1bb74774bbbe0cba3f86e20ddcf41034` is not found."
POST /v2/organizations/{{org_id}}/members/{{user_id}}/decline
cURL
                      
curl -X POST \          
  https://api-eval.signnow.com/v2/organizations/{{org_id}}/members/{{user_id}}/decline \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \ 
                      
                    
Response 201
                {
    No content
}
                
              

Update organization settings

Allows users to update settings for the whole organization.

Parameters
  • org_id required
    Path parameter. ID of the organization to update settings for.
  • setting_name required
    The name of the setting that is changed.
  • value required
    The new value of the setting.

Settings and values:

  • mobileweb_option
  • digitally_sign_dowloaded_docs
  • cloud_export_with_history
  • emailed_docs_include_history
  • require_login_for_signing
  • logout_on_signing
  • document_completion_retention_days
  • audit_trail_completion_retention_days
  • front_end_session_length
  • email_admin_on_banned_login
  • require_authentication_for_invites
  • add_signature_stamp_with_name
  • unsuccessful_logout_attempts_allowed
  • document_guide
  • org_allowed_team_admins
  • cfr_title_21_part_11
  • email_logo_position
  • email_btn_bkgd_color
  • email_btn_text_color
Returns

Returns 204: No content in case of successful response for the admins and moderators with trial, professional and enterprise subscription. Returns an error when:

  • If user is not admin/moderator of the Org, "code": 12003003. Message: "Access denied for current administration role in your organization."
  • If user who does not have appropriate subscription tries to update settings, "code": 12003002. Message: "Access denied for current asubscription."
  • If user tries to update settings of the organization that is not active or does not exist, "code": 12003001. Message: "Organization `de876e793c604dadb99840edc01110d20012dc7a` is not found."
  • The `value` should be a string, "code": 12009004. Message: "The `value` field must be a string."
  • The `setting_name` field is required, "code": 12009001. Message: "The `setting_name` field is required."
  • The `value` field is required, "code": 12009005. Message: "The `value` field is required."
  • The `value` filed can not exceed the limit of 1000 characters, "code": 12009006. Message: "The `value` filed can not exceed the limit of 1000 characters."
  • Organization setting is not found., "code": 12009003. Message: "Organization setting is not found."
PUT /v2/organizations/{{org_id}}/settings
cURL
                      
curl -X PUT \          
  https://api-eval.signnow.com/v2/organizations/{{org_id}}/settings \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \ 
  -d '{
    "setting_name": "user_setting_name", //required, string 
    "value": "setting_value" //required, string
} 
                      
                    
Response 204
                {
    No content
}
                
              

Get organization settings

Allows users to retrieve current settings for the whole organization.

Parameters
  • org_id required
    Path parameter. ID of the organization to retrieve settings for.
Returns

Returns the list of settings in case of successful response for the admins and moderators with trial, professional and enterprise subscription. Returns an error when:

  • If user is not admin/moderator of the Org, "code": 12003003. Message: "Access denied for current administration role in your organization."
  • If user who does not have appropriate subscription tries to update settings, "code": 12003002. Message: "Access denied for current asubscription."
  • If user tries to update settings of the organization that is not active or does not exist, "code": 12003001. Message: "Organization `de876e793c604dadb99840edc01110d20012dc7a` is not found."
GET /v2/organizations/{{org_id}}/settings
cURL
                      
curl -X GET \          
  https://api-eval.signnow.com/v2/organizations/{{org_id}}/settings \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \ 
                      
                    
Response 204
                {
    "data": [
        {
            "setting": "no_document_attachment",
            "value": false,
            "created": 1579703992,
            "updated": 1579703992,
        },
        {
            "setting": "no_user_signature_return",
            "value": "default_setting_value, without casting to bool",
            "created": null,
            "updated": null,
        },
    ],
    "meta": pagination info etc...
    }
                
              

Set an allowed team admin

Allows users allows to set an org allowed team admin.

Parameters
  • org_id required
    Path parameter. ID of the organization where the allowed admin is set.
  • emailrequired
    Email address of the allowed team admin.
Returns

Returns 201: No content in case of successful response for the admins and moderators with trial, professional and enterprise subscription. Returns an error when:

  • If user is not admin/moderator of the Org, "code": 12003003. Message: "Access denied for current administration role in your organization."
  • If user who does not have appropriate subscription tries to update settings, "code": 12003002. Message: "Access denied for current asubscription."
  • If user tries to update settings of the organization that is not active or does not exist, "code": 12003001. Message: "Organization `de876e793c604dadb99840edc01110d20012dc7a` is not found."
  • If user is not found, "code": 12003002. Message: "Access denied for current asubscription."
  • Request without mandatory parameters, "code": 12004001. Message: "The `email` field is required."
  • Organization admin exists, "code": 12004009. Message: "Organization admin exists."
  • Request with invalid value of email parameter, "code": 12004008. Message: "User `kdmvlkmd67@email.com` is not found."
  • User already existing in team admins, "code": 12012012. Message: "Provided organization allowed team admin exists."
POST /v2/organizations/{{org_id}}/allowed-team-admins
cURL
                      
curl -X POST \          
  https://api-eval.signnow.com/v2/organizations/{{org_id}}/allowed-team-admins \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \ 
  -d '{
  "email": "new_allowed_team_admin@email.com",
  }
                      
                    
Response 204
                {
    No content
    }
                
              

Activate/deactivate allowed team admins

Allows users allows to set an org allowed team admin.

Parameters
  • org_id required
    Path parameter. ID of the organization where the allowed admin is activated.
  • emailrequired
    Email address of the allowed team admin.
  • activerequired
    Boolean. Activate or deactivate the allowed team admin. Possible values: true - activate, false - deactivate.
Returns

Returns 204: No content in case of successful response for the admins and moderators with trial, professional and enterprise subscription. Returns an error when:

  • The `email` field must be a string, "code": 12012001. Message: "The `email` field must be a string."
  • The `email` field is required, "code": 12012002. Message: "The `email` field is required."
  • The `active` field is required, "code": 12012014. Message: "The `active` field is required."
  • The `email` is invalid, "code": 12012003. Message: "The `email` is invalid."
  • The `active` field must be a boolean, "code": 12005001. Message: "Organization allowed team admin `email` is not found."
  • User is in the organization but not in the admins, "code": 12012015. Message: "Organization allowed team admin `email` is not found."
PUT /v2/organizations/{{org_id}}/allowed-team-admins
cURL
                      
curl -X PUT \          
  https://api-eval.signnow.com/v2/organizations/{{org_id}}/allowed-team-admins \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \ 
  -d '{
  "email": "new_allowed_team_admin@email.com",
  "active": true
  }
                      
                    
Response 204
                {
    No content
    }
                
              

Get allowed team admins

Allows users allows to retrieve the list of allowed team admins.

Parameters
  • org_id required
    Path parameter. ID of the organization where the allowed admin is retrieved.
  • filters:email optional
    Query parameter. Filter by email. Format: ?filters=[{"email":{"type": "=", "value": user_email}}] (email should be encoded as url)
  • filter:active optional
    Query parameter. Filter by activated/deactivated parameter. Possible values: true, false Format: ?filters=[{"active":{"type": "=", "value": false}}]
Returns

Returns the list of allowed team admins in case of successful response for the admins and moderators with trial, professional and enterprise subscription. Returns an error when:

  • If user is not admin/moderator of the Org, "code": 12003003. Message: "Access denied for current administration role in your organization."
  • If user who does not have appropriate subscription tries to update settings, "code": 12003002. Message: "Access denied for current asubscription."
  • If user tries to update settings of the organization that is not active or does not exist, "code": 12003001. Message: "Organization `de876e793c604dadb99840edc01110d20012dc7a` is not found."
GET /v2/organizations/{{org_id}}/allowed-team-admins
cURL
                      
curl -X GET \          
  https://api-eval.signnow.com/v2/organizations/{{org_id}}/allowed-team-admins \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \ 
                      
                    
Response 200
                {
    "data": [
        {
            "user_id": "%user_id%",
            "email": "%user_email%",
            "active": true/false,
            "created": 1600689195,
            "updated": 1600689195
        },
        {...}
        ],
        "meta": {
            "pagination": {
                "total": 7,
                "count": 7,
                "per_page": 15,
                "current_page": 1,
                "total_pages": 1,
                "links": []
        }
    }
}
                
              

Get all email footers

Allows users to retrieve all email footers of the organization.

Parameters
  • org_id required
    Path parameter. ID of the organization the email footers are retrieved for.
Returns

Returns the list of footers in case of successful response for the admins and moderators with trial, professional and enterprise subscription. Returns an error when:

  • If user is not admin/moderator of the Org, "code": 12003003. Message: "Access denied for current administration role in your organization."
  • If user who does not have appropriate subscription tries to update settings, "code": 12003002. Message: "Access denied for current asubscription."
  • If user tries to update settings of the organization that is not active or does not exist, "code": 12003001. Message: "Organization `de876e793c604dadb99840edc01110d20012dc7a` is not found."
GET /v2/organizations/{{org_id}}/email-footers
cURL
                      
curl -X GET \          
  https://api-eval.signnow.com/v2/organizations/{{org_id}}/email-footers \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \ 
                      
                    
Response 200
                {
    "data": [
        {
            "id": "ca5fe90fc8cc46c9abf84fff101e0df3fcd34334",
            "footer": "footer text",
            "active": true,
            "created_at": 1600251592,
            "updated_at": 1600251592
        },
        {
            "id": "e8ba8568015149188017aaea51610f70d6d1414f",
            "footer": "footer text",
            "active": false,
            "created_at": 1600249745,
            "updated_at": 1600251592
        }
    ],
    "meta": {
        "pagination": {
            "total": 3,
            "count": 3,
            "per_page": 15,
            "current_page": 1,
            "total_pages": 1,
            "links": []
        }
    }
}
                
              

Get members' last logins

Allows users to view the list of last logins of members

Parameters
  • org_id required
    Path parameter. ID of the organization where the members' last logins are retrieved.
  • filters:email optional
    Query parameter. Filter by email. Format: ?filters=[{"email":{"type": "=", "value": user_email}}] (email should be encoded as url)
  • sort:email optional
    Query parameter. Sort by email. Possible values: asc, desc. Format: ?sort[email]=asc
  • sort:updated optional
    Query parameter. Sort by the time of updated. Possible values: asc, desc. Format: ?sort[updated]=asc
Returns

Returns the list of members' last logins in case of successful response for the admins and moderators with trial, professional and enterprise subscription. Returns an error when:

  • If user is not admin/moderator of the Org, "code": 12003003. Message: "Access denied for current administration role in your organization."
  • If user who does not have appropriate subscription tries to update settings, "code": 12003002. Message: "Access denied for current asubscription."
  • If user tries to update settings of the organization that is not active or does not exist, "code": 12003001. Message: "Organization `de876e793c604dadb99840edc01110d20012dc7a` is not found."
GET /v2/organizations/{{org_id}}/members/last-logins
cURL
                      
curl -X GET \          
  https://api-eval.signnow.com/v2/organizations/{{org_id}}/members/last-logins \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \ 
                      
                    
Response 200
                {
    "data": [
        {
            "user_id": "e4b02df7fad849819cf9135131cb7e014ab301c9",
            "email": "signnowqas+11@gmail.com",
            "last_login": 1678032034,
            "ip": "217.20.164.1",
            "user_agent": "user agent test",
            "application": "SignNow Web Application",
            "created_at": 1678032034
        }
    ],
    "meta": {
        "pagination": {
            "total": 1,
            "count": 1,
            "per_page": 15,
            "current_page": 1,
            "total_pages": 1,
            "links": []
        }
    }
}
                
              

Get users' activity

Allows users to view fetching statistics about users who exist in the organization

Parameters
  • org_id required
    Path parameter. ID of the organization where the users' activity is retrieved.
  • date_from optional
    Query parameter. Filter by the date. Format: ?date_from=timestamp&date_to=timestamp
Returns

Returns the audit log of users activity in case of successful response for the admins and moderators with trial, professional and enterprise subscription. Returns an error when:

  • If user is not admin/moderator of the Org, "code": 12003003. Message: "Access denied for current administration role in your organization."
  • If user who does not have appropriate subscription tries to update settings, "code": 12003002. Message: "Access denied for current asubscription."
  • If user tries to update settings of the organization that is not active or does not exist, "code": 12003001. Message: "Organization `de876e793c604dadb99840edc01110d20012dc7a` is not found."
GET /v2/organizations/{{org_id}}/users-activity
cURL
                      
curl -X GET \          
  https://api-eval.signnow.com/v2/organizations/{{org_id}}/users-activity \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \ 
                      
                    
Response 200
                {
    "data": [
        {
            "id": "869c096ddc4f4b6e8fd09d41af313d2f72dac739",
            "email": "user1@yopmail.com",
            "documents": 5,
            "sent_documents": 2,
            "signed_documents": 2,
            "average_complete_time": "0:0:0",
            "signers": 2
        },
        {
            "id": "397f47a606df4a1e8ff9ce0c1a7c4a9e30efa929",
            "email": "user2@yopmail.com",
            "documents": 2,
            "sent_documents": 1,
            "signed_documents": 1,
            "average_complete_time": "1:16:14",
            "signers": 1
        }
    ],
    "meta": {
        "pagination": {
            "total": 2,
            "count": 2,
            "per_page": 15,
            "current_page": 1,
            "total_pages": 1,
            "links": []
        }
    }
}
                
              

Get organization activity

Allows users to view fetching statistics about the organization

Parameters
  • org_id required
    Path parameter. ID of the organization where the organization activity is retrieved.
  • date_from optional
    Query parameter. Filter by the date. Format: ?date_from=timestamp&date_to=timestamp
Returns

Returns the audit log of organization activity in case of successful response for the admins and moderators with trial, professional and enterprise subscription. Returns an error when:

  • If user is not admin/moderator of the Org, "code": 12003003. Message: "Access denied for current administration role in your organization."
  • If user who does not have appropriate subscription tries to update settings, "code": 12003002. Message: "Access denied for current asubscription."
  • If user tries to update settings of the organization that is not active or does not exist, "code": 12003001. Message: "Organization `de876e793c604dadb99840edc01110d20012dc7a` is not found."
GET /v2/organizations/{{org_id}}/activity
cURL
                      
curl -X GET \          
  https://api-eval.signnow.com/v2/organizations/{{org_id}}/activity \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \ 
                      
                    
Response 200
                {
    "data": {
        "documents": 2042,
        "sent_documents": 451,
        "signed_documents": 101,
        "signers": 218,
        "senders": 26,
        "average_complete_time": "0:8:22",
        "active_users": 4652
    }
}