### Example response for GET /v2/signing-session-settings Source: https://docs.signnow.com/docs/document-field-invite/operations/get-v2-signing-session-settings Shows the JSON response structure with the welcome_message field. The example value is "Hi! Please sign this document." ```json { "data": { "welcome_message": "Hi! Please sign this document." } } ``` -------------------------------- ### Example response for GET send-invite resource Source: https://docs.signnow.com/docs/general-branding/operations/get-v2-brands-brand-id-resources-send-invite Example JSON response showing the branding settings for the send invite resource, including visibility flags and background colors. ```json { "data": { "cc-recipients": { "visibility": true }, "customize-message": { "visibility": true }, "from": { "visibility": true }, "header": { "visibility": true }, "preview-panel": { "background": "#f6f8fb", "visibility": true }, "request-payment": { "visibility": true }, "settings": { "visibility": true }, "settings-panel": { "background": "#ffffff" } } } ``` -------------------------------- ### Get event subscription - JSON response example Source: https://docs.signnow.com/docs/webhooks-1/operations/get-event-subscription Example response for the GET /event_subscription endpoint. Shows a list of subscriptions with created timestamp, event type, and id. ```json { "subscriptions": [ { "created": "1410301010", "event": "document.update", "id": "event_id" }, { "created": "1410301010", "event": "document.create", "id": "event_id" } ] } ``` -------------------------------- ### Response example for GET /v2/merchant-accounts/{merchant_account_id} Source: https://docs.signnow.com/docs/request-payments/operations/get-v2-merchant-accounts Example JSON response showing the structure of a successful response, including fields like active, currency, merchant_account_name, and publishable_key. ```json { "data": { "active": true, "created": 1761755047, "currency": "USD", "currency_name": "US Dollar", "display_ach_form": false, "display_credit_card_form": true, "entity_type": "user", "id": "XXXXadb11c8c4658bc2170ded433617b237233ba", "merchant_account_name": "Stripe 1", "merchant_type": "Stripe", "publishable_key": "********iYYY", "secure_key": "********yyyy", "updated": 1761755047 } } ``` -------------------------------- ### Example response for GET /v2/documents/{document_id}/roles Source: https://docs.signnow.com/docs/document/operations/get-document-roles Example JSON response showing a paginated list of users with roles (owner and viewer). The response includes data array with user details and meta.pagination object. ```json { "data": [ { "avatar_url": "https://example.com/avatars/abc123/download", "email": "owner@example.com", "full_name": "John Doe", "id": "abc123def456abc123def456abc123def456abc1", "role": "owner" }, { "avatar_url": null, "email": "viewer@example.com", "full_name": "Jane Smith", "id": "def456abc123def456abc123def456abc123def4", "role": "viewer" } ], "meta": { "pagination": { "count": 2, "current_page": 1, "per_page": 15, "total": 2, "total_pages": 1 } } } ``` -------------------------------- ### Example response for GET /v2/teams/{team_id}/admins Source: https://docs.signnow.com/docs/manage-admins/operations/get-team-admins Example JSON response showing a list of team admins with fields like created, email, primary, type, updated, and user_id. ```json { "data": [ { "created": 1573645637, "email": "admin@signnow.com", "primary": true, "type": 1, "updated": 1573645752, "user_id": "e13b50f63fd5492499b0ed346a3a3db6d045ca37" } ] } ``` -------------------------------- ### Example 1: Paid request logs response Source: https://docs.signnow.com/docs/api-logs/operations/get-v2-paid-request-logs Example response for a successful request to GET /v2/paid-request-logs. Shows the data array with request details and meta.pagination object. ```json { "data": [ { "application_mode": "production", "date": 1572600281, "id": "62a8f4d295b348239fcd32b6b7e1223f", "is_seat": false, "method": "POST", "rate": 1, "request_owner_email": "user1@example.com", "request_type": "signing_link", "uri": "/oauth2/token" }, { "application_mode": "development", "date": 1572600281, "id": "62b3e1dfe8274acfb65e7c12a9c544d9", "is_seat": false, "method": "POST", "rate": 1, "request_owner_email": "user2@example.com", "request_type": "free_form_invite", "uri": "/oauth2/token" } ], "meta": { "pagination": { "count": 2, "current_page": 1, "links": [], "per_page": 15, "total": 2, "total_pages": 1 } } } ``` -------------------------------- ### Response Example 1 Source: https://docs.signnow.com/docs/document-group-template/operations/get-v2-document-group-templates-doc-group-template-id-copies Example JSON response for the GET document group template copies endpoint, showing a document group with a single document and pagination metadata. ```json { "data": [ { "created": 1688481787, "document_group_name": "Onboarding documents", "documents": [ { "id": "01bc639a1d81408b91df6cb62edd1c9874c46b83", "name": "NDA agreement", "roles": [ "Recipient 1" ] } ], "freeform_actions": [], "freeform_invite_id": null, "id": "8a8bc73bd272439e853e8d0faf892d4107287c8a", "invite_id": null, "invites": [], "owner": "owner@email.com", "parent_id": "1f982fea8633418494b622ba7ba07bc476ee94ec", "state": "created", "updated": 1688481787, "user_id": "121c6015e26440c48adbafb720f52007c15c6b0d" } ], "meta": { "pagination": { "count": 1, "current_page": 1, "links": [], "per_page": 15, "total": 1, "total_pages": 1 } } } ``` -------------------------------- ### Example 1: Response JSON Source: https://docs.signnow.com/docs/basic-auth/operations/get-event-subscriptions Example response for the GET /api/v2/events endpoint. Shows a single event subscription with fields like action, active, application_name, event, and pagination metadata. ```json { "data": [ { "action": "callback", "active": true, "application_name": "test_app", "created": 1764154675, "entity_id": 552215426, "entity_type": "document", "entity_unique_id": "55555db945974e2b847b0580d21c386561b415a0", "event": "document.complete", "event_count": null, "event_subscription_owner_email": "user@email.com", "id": "00003383cd4943b3bcc1a95b4491e2373c32b06d", "json_attributes": { "callback_url": "https://webhook.site/a0093533-766c-456e-b625-97592745216a", "docid_queryparam": false, "include_metadata": true, "use_tls_12": true }, "request_method": "post", "version": 2 } ], "meta": { "pagination": { "count": 1, "current_page": 1, "links": [], "per_page": 15, "total": 1, "total_pages": 1 } } } ``` -------------------------------- ### Example response for GET email-general Source: https://docs.signnow.com/docs/general-email-branding/operations/get-v2-brands-brand-id-resources-email-general Shows the JSON response structure returned by the endpoint, including buttons, logo, sender_email, and signnow_references fields. ```json { "buttons": { "background": "#0777cf", "color": "#ffffff" }, "hide_download_image": false, "logo": { "position": "middle" }, "secondary_buttons": { "background": "#e3e6e9", "color": "#38424b" }, "sender_email": "mail@signnow.com", "signnow_references": true } ``` -------------------------------- ### Example JSON response for get user document group templates Source: https://docs.signnow.com/docs/document-group-template/operations/get-user-documentgroup-templates Example response showing the structure of the returned data, including template groups, templates, and invite actions. The response includes fields like template_group_id, template_group_name, and templates array. ```json { "data": [ { "document_group_template_id": "...", "document_group_template_name": "...", "document_group_template_info": { "invite_actions": [ { "action": "sign", "allow_reassign": 0, "authentication": { "type": null }, "decline_by_signature": 0, "document_id": "...", "document_name": "...", "email": "...", "role_name": "...", "uuid": "..." } ], "invite_emails": [ { "email": "...", "expiration_days": 30, "has_sign_actions": true, "message": "...", "reminder": { "remind_after": 0, "remind_before": 0, "remind_repeat": 0 }, "subject": "..." } ], "order": 4 }, "template_group_id": "...", "template_group_name": "...", "templates": [ { "id": "...", "name": "...", "roles": [ "..." ], "thumbnail": { "large": "...", "medium": "...", "small": "..." } } ] } ] } ``` -------------------------------- ### Sample JSON Response for Get Template Routing Details Source: https://docs.signnow.com/docs/template/operations/get-template-routing-details Example response from the SignNow API for the 'Get Template Routing Details' endpoint. It shows the structure of the response including approvers, attributes, cc, cc_step, invite_link_instructions, routing_details, and viewers arrays. ```json { "approvers": [ { "authentication": null, "default_email": "director@example.com", "expiration_days": 15, "inviter_role": false, "name": "Director of Sales", "signing_order": 3 }, { "authentication": null, "default_email": "vp.finance@example.com", "name": "VP Finance", "signing_order": 4 } ], "attributes": { "brand_id": "99887766554433221100aabbccddeeff11223344", "on_complete": "redirect", "redirect_uri": "https://example.com/thank-you" }, "cc": [ "manager@example.com", "hr.department@example.com" ], "cc_step": [ { "email": "compliance@example.com", "name": "Compliance Team", "step": 1 }, { "email": "records@example.com", "name": "Records Keeping", "step": 2 } ], "invite_link_instructions": "Please review the attached contract details before signing.", "routing_details": [ { "default_email": "john.smith@example.com", "inviter_role": false, "name": "John Smith", "role_id": "a1b2c3d4e5f67890123456789abcdef012345678", "signing_order": 1 }, { "default_email": "alice.johnson@example.com", "inviter_role": false, "name": "Alice Johnson", "role_id": "f0e9d8c7b6a543210987654321fedcba09876543", "signing_order": 2 } ], "viewers": [ { "contact_id": "1234567890abcdef1234567890abcdef12345678", "default_email": "legal.observer@example.com", "inviter_role": false, "name": "Legal Observer", "signing_order": 1 }, { "default_email": "auditor@example.com", "name": "External Auditor", "signing_order": 2 } ] } ``` -------------------------------- ### GET /v2/teams - JSON response example Source: https://docs.signnow.com/docs/manage-team/operations/get-user-teams Example response for the GET /v2/teams endpoint. Shows the structure of the data array and meta.pagination object. ```json { "data": [ { "active": 1, "created": 1573658889, "id": "e8XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Team 1", "role": "admin", "type": "VIEWABLE" } ], "meta": { "pagination": { "count": 1, "current_page": 1, "links": { "next": "https://example.com/v2/teams?page=2" }, "per_page": 15, "total": 1, "total_pages": 1 } } } ``` -------------------------------- ### GET /v2/teams - cURL request example Source: https://docs.signnow.com/docs/manage-team/operations/get-user-teams Example cURL command to call the GET /v2/teams endpoint. Requires a Bearer token in the Authorization header. ```bash curl -X GET \ "https://api.signnow.com/v2/teams" \ -H "Authorization: Bearer {access_token}" \ -H "Content-Type: application/json" ``` -------------------------------- ### Response example for POST /event_subscription Source: https://docs.signnow.com/docs/webhooks-1/operations/post-event-subscription Example JSON response with created, id, and updated fields. ```json { "created": 1414441545, "id": "5a8123c4059a03f6eli47d66ef84694b9109845e", "updated": 1414442202 } ``` -------------------------------- ### Example response with placeholder values Source: https://docs.signnow.com/docs/request-payments/operations/get-organizations-org-id-merchantaccount-merchant-account-id Shows a response with placeholder values for account details. ```JSON { "account_name": "account_name", "id": "unique_id", "json_attributes": "json_attributes", "merchant_account_id": "merchant_account_id", "merchant_type": "merchant_name" } ``` -------------------------------- ### Successful response example Source: https://docs.signnow.com/docs/contacts/operations/get-v2-crm-contacts Example of a successful response from the GET /v2/crm/contacts endpoint, showing the structure of contact data and pagination metadata. ```json { "data": [ { "address": { "apartment": "Penthouse", "city": "New York", "country": "US", "state": "New York", "street": "5 Avenue", "zip_code": "0" }, "company": { "job_title": "PHP Developer", "name": "Sample name" }, "description": "Best client", "email": "crm@example.com", "first_name": "John", "id": "8fXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "last_name": "Doe", "meta": { "created_at": 1649926419, "interacted_at": 1649926419, "updated_at": 1649926419 }, "phone": { "country_code": "US", "number": "1234567890" } } ], "meta": { "pagination": { "count": 10, "current_page": 2, "links": { "next": "https://example.com/v2/crm/contacts?per_page=10&page=3", "previous": "https://example.com/v2/crm/contacts?per_page=10&page=1" }, "per_page": 15, "total": 50, "total_pages": 5 } } } ``` -------------------------------- ### Example request with query parameters Source: https://docs.signnow.com/docs/template/operations/get-v2-templates-template-id-copies Shows a GET request to /v2/templates/{template_id}/copies with query parameters for sorting, pagination, and filtering by signing status. ```JSON 1/v2/templates/{template_id}/copies?sort_by=created&sort_order=desc&per_page=20&filters[signing_status]=pending` ``` -------------------------------- ### Response example for POST /link Source: https://docs.signnow.com/docs/signing-link/operations/create-signing-link JSON example of the response containing the signing link and QR code URLs. ```json { "url": "https://signnow.com/s/e9P6v1WW", "url_no_signup": "https://signnow.com/s/NKb23XO3", "url_no_signup_qrcode": "https://signnow.com/qrcode/NKb23XO3", "url_qrcode": "https://signnow.com/qrcode/e9P6v1WW" } ``` -------------------------------- ### Get brand - Example response Source: https://docs.signnow.com/docs/general-branding/operations/get-v2-brands-brand-id Example of a successful response (200) for the GET /v2/brands/{brand_id} endpoint. The response contains the brand's title, unique_id, logo link, and styling resources such as button colors, header background, icons, and text colors. ```json { "data": { "resources": { "general": { "buttons": { "default": { "active-background": "#913c03", "active-border": "#ffffff", "active-color": "#520128", "background": "#f59758", "border": "#ffffff", "color": "#de4991", "hover-background": "#b85c1f", "hover-border": "#ffffff", "hover-color": "#94074b" }, "dropdown": { "active-background": "#913c03", "active-border": "#ffffff", "active-color": "#520128", "background": "#f59758", "border": "#ffffff", "color": "#de4991", "hover-background": "#b85c1f", "hover-border": "#ffffff", "hover-color": "#94074b" }, "primary": { "active-background": "#913c03", "active-border": "#ffffff", "active-color": "#520128", "background": "#f59758", "border": "#ffffff", "color": "#de4991", "hover-background": "#b85c1f", "hover-border": "#ffffff", "hover-color": "#94074b" }, "secondary": { "active-background": "#913c03", "active-border": "#ffffff", "active-color": "#520128", "background": "#f59758", "border": "#ffffff", "color": "#de4991", "hover-background": "#b85c1f", "hover-border": "#ffffff", "hover-color": "#94074b" } }, "header": { "background": "#edaa53" }, "icons": { "background": "#f59758", "border": "#ffffff", "color": "#de4991", "hover-background": "#b85c1f", "hover-border": "#ffffff", "hover-color": "#94074b" }, "texts": { "color": "#080605" } }, "logo": { "data": { "original": "https://example.com/v2/brands/3bXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/logo" }, "link": "https://example.com/v2/brands/3bXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/logo" } }, "title": "Sample brand", "unique_id": "3bXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" } } ``` -------------------------------- ### Get Document JSON Response Source: https://docs.signnow.com/docs/document/operations/get-document Example JSON response from the Get Document endpoint, showing document fields such as settings, signatures, and metadata. ```json { "id": "a0XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "created": "1565858757", "updated": "1565858757", "user_id": "89XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "template": false, "version_time": "1565858757", "thumbnail": { "large": "https://example.com/document/a0XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=large", "medium": "https://example.com/document/a0XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=medium", "small": "https://example.com/document/a0XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=small" }, "signatures": [ { "created": "1565858757", "data": "some_data", "email": "signer@email.com", "height": "21", "id": "26XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "page_number": "0", "user_id": "e9XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "width": "56", "x": "70", "y": "362" } ], "signing_session_settings": { "welcome_message": null }, "tags": [ { "name": "fields", "type": "system" } ], "texts": [], "viewer_field_invites": [] } ``` -------------------------------- ### Response example for application/json Source: https://docs.signnow.com/docs/signing-link/operations/create-signing-link Another JSON response example with different URLs. ```json { "url": "https://signnow.com/s/YYY6v1WW", "url_no_signup": "https://signnow.com/s/xxx23XO3", "url_no_signup_qrcode": "https://signnow.com/qrcode/XXX23XO3", "url_qrcode": "https://signnow.com/qrcode/XXX6v1WW" } ``` -------------------------------- ### Example: application/json (JSON) Source: https://docs.signnow.com/docs/document-embedded-signing/operations/create-embedded-signing-invite Example JSON response for an application/json request. Shows multiple signers and approvers with different orders and statuses. ```JSON { "data": [ { "email": "signer1@email.com", "id": "03XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "order": 1, "role_id": "33XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "status": "pending" }, { "email": "signer2@email.com", "id": "b9XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "order": 1, "role_id": "88XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "status": "pending" }, { "email": "signer3@email.com", "id": "c7XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "order": 1, "role_id": "99XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "status": "pending" }, { "email": "approver1@email.com", "id": "a4XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "order": 4, "role_id": "44XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "status": "created" }, { "email": "approver2@email.com", "id": "a5XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "order": 5, "role_id": "55XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "status": "created" } ] } ``` -------------------------------- ### Successful request: Response JSON Source: https://docs.signnow.com/docs/basic-auth/operations/get-event-subscriptions Example response for a successful request to GET /api/v2/events. Similar to Example 1 but with a different entity_unique_id and event_subscription_owner_email. ```json { "data": [ { "action": "callback", "active": true, "application_name": "test_app", "created": 1764154675, "entity_id": 552215426, "entity_type": "document", "entity_unique_id": "f1c71db945974e2b847b0580d21c386561b415a0", "event": "document.complete", "event_count": null, "event_subscription_owner_email": "greenanna070@gmail.com", "id": "d5543383cd4943b3bcc1a95b4491e2373c32b06d", "json_attributes": { "callback_url": "https://webhook.site/a0093533-766c-456e-b625-97592745216a", "docid_queryparam": false, "include_metadata": true, "use_tls_12": true }, "request_method": "post", "version": 2 } ], "meta": { "pagination": { "count": 1, "current_page": 1, "links": [], "per_page": 15, "total": 1, "total_pages": 1 } } } ``` -------------------------------- ### Response example (JSON) Source: https://docs.signnow.com/docs/document-group/operations/update-document-group-role Example JSON response after successfully updating the role. Contains the user's email, id, and new role. ```JSON { "email": "user@example.com", "id": "def456abc123def456abc123def456abc123defg", "role": "sender" } ``` -------------------------------- ### Run the callback server (npm init, install, start) Source: https://docs.signnow.com/docs/guides-handling-signnow-event-callbacks Commands to initialize a Node.js project, install Express, and start the server with the SIGNNOW_SECRET_KEY environment variable. Set SIGNNOW_SECRET_KEY to the same value used when creating the subscription; leave unset to skip verification for a quick test. ```bash npm init -y npm install express SIGNNOW_SECRET_KEY=MySecretKey node server.js ``` -------------------------------- ### Example response: Example 1 Source: https://docs.signnow.com/docs/document-group/operations/get-document-group-roles Shows a sample JSON response with two users: an owner and a viewer. The owner has an avatar URL, while the viewer's avatar_url is null. Pagination meta indicates 2 items on page 1. ```json { "data": [ { "avatar_url": "https://example.com/avatars/abc123/download", "email": "owner@example.com", "full_name": "John Doe", "id": "abc123def456abc123def456abc123def456abcd", "role": "owner" }, { "avatar_url": null, "email": "viewer@example.com", "full_name": "Jane Smith", "id": "def456abc123def456abc123def456abc123defg", "role": "viewer" } ], "meta": { "pagination": { "count": 2, "current_page": 1, "per_page": 15, "total": 2, "total_pages": 1 } } } ``` -------------------------------- ### Response: Example 1 Source: https://docs.signnow.com/docs/general-branding/operations/get-v2-brands Example response showing a common brand and an organization brand with only the editor resource configured. ```json { "data": [ { "link": "https://api.signnow.com/v2/brands/0f7848d0cfadeb2cdd230e4ad433efbca2423d8f", "owner_type": "common", "resources": [], "title": "SignNow", "unique_id": "0f7848d0cfadeb2cdd230e4ad433efbca2423d8f" }, { "link": "https://api.signnow.com/v2/organizations/1b63e416095d4734a0e0d8bce4bd33f7b44b7585/brands/d14d3a3df33144009ee8dc51b1f4b0dacf9a9763", "owner_type": "organization", "resources": { "editor": { "data": null, "link": "https://api.signnow.com/v2/organizations/1b63e416095d4734a0e0d8bce4bd33f7b44b7585/brands/d14d3a3df33144009ee8dc51b1f4b0dacf9a9763/resources/editor" } }, "title": "Brand_1", "unique_id": "d14d3a3df33144009ee8dc51b1f4b0dacf9a9763" } ], "meta": { "pagination": { "count": 3, "current_page": 1, "links": [], "per_page": 15, "total": 3, "total_pages": 1 } } } ``` -------------------------------- ### cURL request example for GET /v2/paid-request-monthly-totals Source: https://docs.signnow.com/docs/api-logs/operations/get-v2-paid-request-monthly-totals Example cURL command to call the endpoint. Requires a Bearer token in the Authorization header and sets Content-Type to application/json. ```bash curl -X GET \ "https://api.signnow.com/v2/paid-request-monthly-totals" \ -H "Authorization: Bearer {access_token}" \ -H "Content-Type: application/json" ``` -------------------------------- ### Request body example for POST /link Source: https://docs.signnow.com/docs/signing-link/operations/create-signing-link JSON example of the request body for creating a signing link. Includes document_id, firstname, lastname, and redirect_uri. ```json { "document_id": "bf19a9dba96745b6bf516dc4118ea639faac18f3", "firstname": "Jane", "lastname": "Doe", "redirect_uri": "https://example.com?firstname=[smart_fields.firstname]&lastname=[smart_fields.lastname]" } ``` -------------------------------- ### Get doc group templates response (JSON) Source: https://docs.signnow.com/docs/sign-pdfs-in-wordpress Example JSON response from the Get doc group templates endpoint, showing the template_id and template_name for the created template. ```JSON { "document_group_templates": [ { "template_id": "3c8f0a2e6b1d47598c3a5e9b7d0f2a4c6e8b1d39", "template_name": "Client Service Agreement template" } ] } ``` -------------------------------- ### Get list of webhook event subscriptions (GET /v2/event-subscriptions) Source: https://docs.signnow.com/docs/guides-webhooks Retrieves the list of webhook event subscriptions that you have subscribed to. The response example shows the structure of the returned data. ```JSON curl --request GET \ --url https://api.signnow.com/v2/event-subscriptions \ --header 'Accept: application/json' \ --header 'Authorization: Bearer {{access_token}}' \ --header 'Content-Type: application/json' ``` ```JSON { "data": [ { "id": "b3XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "entity_type": "user", "event": "user.document.fieldinvite.sent", "entity_id": 126390148, "entity_unique_id": "b2XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "request_method": "post", "action": "callback", "active": true, "json_attributes": { "use_tls_12": false, "docid_queryparam": false, "callback_url": "http://example.com/" }, "application_name": "Sample App", "version": 2, "created": 1688128984 } ], "meta": { "pagination": { "total": 3, "count": 3, "per_page": 15, "current_page": 1, "total_pages": 1, "links": [] } } } ``` -------------------------------- ### Example: application/json response for creating a user Source: https://docs.signnow.com/docs/user/operations/post-user Another example response body with a placeholder id (masked with X's) and verified field set to 0. ```json { "email": "user@email.com", "id": "aaXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "verified": 0 } ``` -------------------------------- ### Example Success Response (JSON) Source: https://docs.signnow.com/docs/doc-group-field-invite/operations/get-document-group-invite Example JSON response for a successful request, showing the invite object with id, status, and ordered steps with actions. ```json { "invite": { "id": "b1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "status": "pending", "steps": [ { "actions": [ { "action": "sign", "document_id": "ddXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": "signer1@email.com", "role_name": "Signer 1", "signer_phone_invite": null, "status": "pending" }, { "action": "sign", "document_id": "ddXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email_group": { "id": "unique_id_of_the_group", "name": "group name" }, "role_name": "Signer 1", "signer_phone_invite": null, "status": "pending" }, { "action": "sign", "document_id": "cdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": "signer2@email.com", "role_name": "Signer 2", "signer_phone_invite": null, "status": "pending" }, { "action": "sign", "document_id": "cdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": null, "role_name": "Signer 2 (SMS)", "signer_phone_invite": "+14075985199", "status": "pending" } ], "id": "abXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "order": 1, "status": "pending" }, { "actions": [ { "action": "sign", "document_id": "ddXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": "signer3@email.com", "role_name": "Signer 3", "signer_phone_invite": null, "status": "created" }, { "action": "sign", "document_id": "ddXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": "signer4@email.com", "role_name": "Signer 4", "signer_phone_invite": null, "status": "created" } ], "id": "deXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "order": 2, "status": "created" }, { "actions": [ { "action": "sign", "document_id": "cdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": "signer5@email.com", "role_name": "Signer 5", "signer_phone_invite": null, "status": "created" }, { "action": "sign", "document_id": "cdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": "signer6@email.com", "role_name": "Signer 6", "signer_phone_invite": null, "status": "created" } ], "id": "c1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "order": 3, "status": "created" } ] } } ``` -------------------------------- ### cURL request to get application brand Source: https://docs.signnow.com/docs/general-branding/operations/get-v2-applications-application-id-brand Example cURL command to call the GET /v2/applications/{application_id}/brand endpoint. Requires a Bearer token and Content-Type header. ```bash curl -X GET \ "https://api.signnow.com/v2/applications/{application_id}/brand" \ -H "Authorization: Bearer {access_token}" \ -H "Content-Type: application/json" ``` -------------------------------- ### Example 1: Organization settings response Source: https://docs.signnow.com/docs/organization/operations/get-v2-organizations-org-id-settings Example JSON response showing a list of organization settings with pagination metadata. The response includes settings such as no_document_attachment, mobileweb_option, and require_drawn_signatures. ```json { "data": [ { "created": null, "default_value": "0", "setting": "no_document_attachment", "updated": null, "value": null }, { "created": null, "default_value": "0", "setting": "no_document_file_attachments", "updated": null, "value": null }, { "created": null, "default_value": "app_or_mobileweb_choice", "setting": "mobileweb_option", "updated": null, "value": null }, { "created": null, "default_value": "0", "setting": "require_drawn_signatures", "updated": null, "value": null }, { "created": null, "default_value": "0", "setting": "org_allowed_team_admins", "updated": null, "value": null }, { "created": null, "default_value": "no", "setting": "digitally_sign_dowloaded_docs", "updated": null, "value": null }, { "created": null, "default_value": "no", "setting": "pending_invite_document_view_notification", "updated": null, "value": null }, { "created": null, "default_value": "0", "setting": "cloud_export_with_history", "updated": null, "value": null }, { "created": null, "default_value": "0", "setting": "emailed_docs_include_history", "updated": null, "value": null }, { "created": 1736061495, "default_value": "0", "setting": "require_email_subject", "updated": 1736061497, "value": "0" }, { "created": null, "default_value": "0", "setting": "document_completion_retention_days", "updated": null, "value": null }, { "created": null, "default_value": "0", "setting": "require_login_for_signing", "updated": null, "value": null }, { "created": null, "default_value": "0", "setting": "logout_on_signing", "updated": null, "value": null }, { "created": null, "default_value": "0", "setting": "audit_trail_completion_retention_days", "updated": null, "value": null }, { "created": null, "default_value": "0", "setting": "front_end_session_length", "updated": null, "value": null } ], "meta": { "pagination": { "count": 15, "current_page": 1, "links": { "next": "https://api.signnow.com/v2/organizations/5d07bfbb31bb486bb636fb992cd6d05ca677be54/settings?page=2" }, "per_page": 15, "total": 42, "total_pages": 3 } } } ``` -------------------------------- ### Example: example-1 (JSON response) Source: https://docs.signnow.com/docs/template/operations/post-import-document-templates Another JSON response example with actual document IDs, showing the same structure as the previous example. Includes a failure case with a processing_error. ```json [ { "document_id": "f38b14c3da4aad10beee7fd76074ab7f08c57759", "document_name": "document name 1", "file_size": 12345 }, { "document_id": "45b21ec8a9e7c18fba33cd4cbba72c9c3925ff62", "document_name": "document name 2", "file_size": 12345 }, { "document_id": null, "document_name": "document name 3", "file_size": null, "processing_error": "Data does not contain valid json'" } ] ``` -------------------------------- ### Example 1 response Source: https://docs.signnow.com/docs/manage-users/operations/get-api-v2-teams-team-id-users Example response for the GET /v2/teams/{team_id}/members endpoint. Shows a single member with fields like email, name, and pagination metadata. ```json { "data": [ { "active": 1, "created": 1714404437, "email": "j.doe@email.com", "first_name": "Jane", "id": "1234567890123456789012345678901234567890", "is_admin": 1, "last_name": "Doe", "pro": 0, "type": 1, "updated": 1714404437 } ], "meta": { "pagination": { "count": 1, "current_page": 1, "links": [], "per_page": 15, "total": 1, "total_pages": 1 } } } ``` -------------------------------- ### Example 1: JSON response for creating a user Source: https://docs.signnow.com/docs/user/operations/post-user Example response body showing a user object with email, id, and verified fields. The verified field is 0, indicating the user is not yet verified. ```json { "email": "user@signnow.com", "id": "aad13814e8f369089ee2f12b533545f9534e6cf8", "verified": 0 } ``` -------------------------------- ### Example response: application/json Source: https://docs.signnow.com/docs/document-group/operations/get-document-group-roles Another sample JSON response with the same structure but both users have avatar URLs. This is the application/json media type example. ```json { "data": [ { "avatar_url": "https://example.com/avatars/abc123/download", "email": "owner@example.com", "full_name": "John Doe", "id": "abc123def456abc123def456abc123def456abcd", "role": "owner" }, { "avatar_url": "https://example.com/avatars/abc456/download", "email": "viewer@example.com", "full_name": "Jane Smith", "id": "def456abc123def456abc123def456abc123defg", "role": "viewer" } ], "meta": { "pagination": { "count": 2, "current_page": 1, "per_page": 15, "total": 2, "total_pages": 1 } } } ``` -------------------------------- ### Example request body for moving a user Source: https://docs.signnow.com/docs/organization/operations/put-v2-organizations-destination-org-id-move JSON example showing the request body with 'from' and 'user_id' fields. ```json { "from": "34XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "user_id": "12XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" } ``` -------------------------------- ### GET /request-logs/{request_id} - cURL example Source: https://docs.signnow.com/docs/api-logs/operations/get-request-logs-request-id Use this cURL command to retrieve a specific request log. Replace {request_id} with the ID from GET /request-logs and {access_token} with your Bearer token. ```bash curl -X GET \ "https://api.signnow.com/request-logs/{request_id}" \ -H "Authorization: Bearer {access_token}" \ -H "Content-Type: application/json" ``` -------------------------------- ### Success response example Source: https://docs.signnow.com/docs/template/operations/bulk-invite Example JSON response indicating the bulk invite job has been queued. ```json 1{ 2 "status": "job queued" 3} ``` -------------------------------- ### cURL request to get users activity Source: https://docs.signnow.com/docs/organization/operations/get-v2-organizations-org-id-users-activity Example cURL command to call the GET /v2/organizations/{org_id}/users-activity endpoint. Requires a Bearer token in the Authorization header and Content-Type: application/json. ```bash curl -X GET \ "https://api.signnow.com/v2/organizations/{org_id}/users-activity" \ -H "Authorization: Bearer {access_token}" \ -H "Content-Type: application/json" ``` -------------------------------- ### Create organization response example Source: https://docs.signnow.com/docs/organization/operations/post-v2-organizations Example response containing the `id` of the created organization. ```JSON { "id": "1afee427a35e404e9eb6f98cb6586f5e3ccef0a2" } ```