{"_id":"55fa37cb8065a10d004e5bc6","editedParams":true,"editedParams2":true,"parentDoc":null,"category":{"_id":"55fa37ca8065a10d004e5bb8","pages":["55fa37cb8065a10d004e5bc5","55fa37cb8065a10d004e5bc6","55fa37cb8065a10d004e5bc7","55fa37cb8065a10d004e5bc8","55fa37cb8065a10d004e5bc9","55fa37cb8065a10d004e5bca","55fa37cb8065a10d004e5bcb","55fa37cb8065a10d004e5bcc","55fa37cb8065a10d004e5bcd","55fa3dd4a663c00d00773dd1","55fa409d8065a10d004e5bda","55fa463317b9d00d00969ead","55fa4822764f5021009506c0","55fa4bfeaba81f0d00a115e7","55fa4dcd17b9d00d00969eb7","55fca6ccf95c5b0d0068fdfa","55fe6735748eb30d008a1e61","55ff4d91cc468e0d008dce5f","55ff558a9e7ccf0d000a1d49","55ff5695cc468e0d008dce67","55ff6e986932a00d00ba7a37","55ff702f9e7ccf0d000a1d83","560221271ba3720d00a6b99d","560221418a6c97170066cf48","563e18aad6db8d17008389ac"],"version":"55fa37c88065a10d004e5bb6","project":"54e405191e51932d006abc39","__v":17,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-06-06T05:42:37.534Z","from_sync":false,"order":3,"slug":"users","title":"Users"},"user":"54e4044e8ef7552300409dcb","__v":6,"project":"54e405191e51932d006abc39","version":{"_id":"55fa37c88065a10d004e5bb6","project":"54e405191e51932d006abc39","__v":9,"createdAt":"2015-09-17T03:47:20.956Z","releaseDate":"2015-09-17T03:47:20.956Z","categories":["55fa37ca8065a10d004e5bb7","55fa37ca8065a10d004e5bb8","55fa37ca8065a10d004e5bb9","55fa37ca8065a10d004e5bba","55fca6bf34ae7c0d00ab8ea0","55ff80fd9e7ccf0d000a1d93","560220af7435de0d00fabd0d","56107f21bb9d920d00303e70","563e184077681a0d00d96a02","56fafc6596ec7e0e002ac85f","5915e54f7c2c552d008b8549","59499fcd64b5f5002690bbc1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"REST V3","version_clean":"3.1.0","version":"3.1"},"updates":["55771909a042551900b0025a","557f3adde211d20d00601455","55a0286f5730f40d0011042e"],"next":{"pages":[],"description":""},"createdAt":"2015-06-06T05:44:00.497Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","code":"GET /v3.1/users HTTP/1.1\nHost: uat-api.synapsefi.com\nX-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267\nX-SP-USER-IP: 127.0.0.1\nX-SP-USER: |e83cf6ddcf778e37bfe3d48fc78a6502062fc","language":"http"}]},"method":"get","results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n    \"error_code\": \"0\",\n    \"http_code\": \"200\",\n    \"limit\": 20,\n    \"page\": 1,\n    \"page_count\": 688,\n    \"success\": true,\n    \"users\": [\n        {\n            \"_id\": \"594dad16838454002da3015f\",\n            \"_links\": {\n                \"self\": {\n                    \"href\": \"https://uat-api.synapsefi.com/v3.1/users/594dad16838454002da3015f\"\n                }\n            },\n            \"client\": {\n                \"id\": \"589acd9ecb3cd400fa75ac06\",\n                \"name\": \"SynapseFI\"\n            },\n            \"doc_status\": {\n                \"physical_doc\": \"SUBMITTED|VALID\",\n                \"virtual_doc\": \"SUBMITTED|VALID\"\n            },\n            \"documents\": [\n                {\n                    \"id\": \"189d2fc37c1ee5694aa62f302bcd7c0efa\",\n                    \"name\": \"Charlie Brown\",\n                    \"permission_scope\": \"SEND|RECEIVE|1000|DAILY\",\n                    \"physical_docs\": [\n                        {\n                            \"document_type\": \"GOVT_ID\",\n                            \"id\": \"e6b44cb52985fd9f46197bec0fb4e9c\",\n                            \"last_updated\": 1498262807101,\n                            \"status\": \"SUBMITTED|VALID\"\n                        }\n                    ],\n                    \"social_docs\": [\n                        {\n                            \"document_type\": \"PHONE_NUMBER\",\n                            \"id\": \"54522fd5748d2dedeab0034a09f91\",\n                            \"last_updated\": 1498262807104,\n                            \"status\": \"SUBMITTED|VALID\"\n                        },\n                        {\n                            \"document_type\": \"FACEBOOK\",\n                            \"id\": \"0c32234c59b71311b0f3057635\",\n                            \"last_updated\": 1498262807104,\n                            \"status\": \"SUBMITTED|VALID\"\n                        },\n                        {\n                            \"document_type\": \"EMAIL\",\n                            \"id\": \"2c45158f6431ca874bbe82\",\n                            \"last_updated\": 1498262807104,\n                            \"status\": \"SUBMITTED|VALID\"\n                        },\n                        {\n                            \"document_type\": \"IP\",\n                            \"id\": \"28d9177b22c127d9a51d8903\",\n                            \"last_updated\": 1498262807104,\n                            \"status\": \"SUBMITTED|VALID\"\n                        }\n                    ],\n                    \"virtual_docs\": [\n                        {\n                            \"document_type\": \"SSN\",\n                            \"id\": \"acaff78248e74aac19c2a4531\",\n                            \"last_updated\": 1498262807099,\n                            \"status\": \"SUBMITTED|INVALID\"\n                        }\n                    ]\n                }\n            ],\n            \"emails\": [],\n            \"extra\": {\n                \"cip_tag\": 1,\n                \"date_joined\": 1498262801436,\n                \"extra_security\": true,\n                \"is_business\": false,\n                \"last_updated\": 1498262807088,\n                \"public_note\": null,\n                \"supp_id\": \"122eddfgbeafrfvbbb\"\n            },\n            \"is_hidden\": false,\n            \"legal_names\": [\n                \"Charlie Brown\"\n            ],\n            \"logins\": [\n                {\n                    \"email\": \"sankaet:::at:::synapsepay.com\",\n                    \"scope\": \"READ_AND_WRITE\"\n                }\n            ],\n            \"permission\": \"SEND-AND-RECEIVE\",\n            \"phone_numbers\": [\n                \"sankaet@synapsepay.com\",\n                \"901.942.8167\"\n            ],\n            \"photos\": [],\n            \"refresh_token\": \"refresh_xsAb2Pv9Sf8QNBq1yMhlcGoTwVJ0mEUjeF3XnILi\"\n        },\n        {\n            ...\n        },\n        {\n            ...\n        },\n        {   ...\n        },\n        ...\n    ],\n    \"users_count\": 13760\n}"}]},"settings":"","auth":"required","params":[{"_id":"5573b11e91ce6e190023b76a","ref":"","in":"query","required":false,"desc":"Name/Email of the user that you wish to search","default":"","type":"string","name":"query"},{"_id":"55728c20e42c040d00d68a9f","ref":"","in":"query","required":false,"desc":"Page number","default":"","type":"int","name":"page"},{"_id":"560c79c2e10d100d00dbd6c7","ref":"","in":"query","required":false,"desc":"How many users do you want us to return per page.","default":"20","type":"int","name":"per_page"},{"_id":"589b5b14291da51b004b3118","ref":"","in":"query","required":false,"desc":"[yes/no] When dehydrating if the user object should have refresh tokens or not.","default":"yes","type":"string","name":"show_refresh_tokens"}],"url":"/v3.1/users"},"isReference":true,"order":1,"body":"[block:image]\n{\n  \"images\": [\n    {\n      \"image\": []\n    }\n  ]\n}\n[/block]\n\n## Searching for users\n\nYou can also search for users by email or name.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v3.1/users?query=test HTTP/1.1\\nHost: uat-api.synapsefi.com\\nX-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267\\nX-SP-USER-IP: 127.0.0.1\\nX-SP-USER: |e83cf6ddcf778e37bfe3d48fc78a6502062fc\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n## Pagination\n\nResponses are paginated, so to move through pages, add **page** as a GET parameter. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v3.1/users?page=1 HTTP/1.1\\nHost: uat-api.synapsefi.com\\nX-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267\\nX-SP-USER-IP: 127.0.0.1\\nX-SP-USER: |e83cf6ddcf778e37bfe3d48fc78a6502062fc\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\nCombination of page and query is also available.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v3.1/users?query=test&page=1 HTTP/1.1\\nHost: uat-api.synapsefi.com\\nX-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267\\nX-SP-USER-IP: 127.0.0.1\\nX-SP-USER: |e83cf6ddcf778e37bfe3d48fc78a6502062fc\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"create-a-usercustomer","type":"endpoint","title":"Users"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

query:
string
Name/Email of the user that you wish to search
page:
integer
Page number
per_page:
integer20
How many users do you want us to return per page.
show_refresh_tokens:
stringyes
[yes/no] When dehydrating if the user object should have refresh tokens or not.

Examples


Result Format


Documentation

[block:image] { "images": [ { "image": [] } ] } [/block] ## Searching for users You can also search for users by email or name. [block:code] { "codes": [ { "code": "GET /v3.1/users?query=test HTTP/1.1\nHost: uat-api.synapsefi.com\nX-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267\nX-SP-USER-IP: 127.0.0.1\nX-SP-USER: |e83cf6ddcf778e37bfe3d48fc78a6502062fc", "language": "http" } ] } [/block] ## Pagination Responses are paginated, so to move through pages, add **page** as a GET parameter. [block:code] { "codes": [ { "code": "GET /v3.1/users?page=1 HTTP/1.1\nHost: uat-api.synapsefi.com\nX-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267\nX-SP-USER-IP: 127.0.0.1\nX-SP-USER: |e83cf6ddcf778e37bfe3d48fc78a6502062fc", "language": "http" } ] } [/block] Combination of page and query is also available. [block:code] { "codes": [ { "code": "GET /v3.1/users?query=test&page=1 HTTP/1.1\nHost: uat-api.synapsefi.com\nX-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267\nX-SP-USER-IP: 127.0.0.1\nX-SP-USER: |e83cf6ddcf778e37bfe3d48fc78a6502062fc", "language": "http" } ] } [/block]