{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/users","auth":"required","results":{"codes":[{"name":"","code":"{\n   \"users\" : [\n      {\n         \"email\" : \"ken:::at:::example.com\",\n         \"name\" : \"Ken Baylor\",\n         \"id\" : \"517ffdbd-b20f-4082-82f8-eb3c732ab00c\"\n      },\n      {\n         \"email\" : \"[email protected]\",\n         \"name\" : \"Mark\",\n         \"id\" : \"5595f262-53ba-46b3-86c3-b20b785ef6da\"\n      },\n      {\n         \"name\" : \"Joey\",\n         \"email\" : \"[email protected]\",\n         \"id\" : \"910e6f68-432a-4440-a806-bcb218d36542\"\n      }\n   ]\n}","language":"json","status":200}]},"settings":"","params":[{"name":"api_token","type":"string","default":"secret-api-token","desc":"Required if api_token is not passed in header","required":true,"in":"query","ref":"","_id":"5cd4c372a8c29e006362d65d"}],"examples":{"codes":[{"language":"curl","code":"curl -X GET 'https://api.fountain.com/v2/users' -H 'X-ACCESS-TOKEN: secret-api-token'"}]},"method":"get"},"next":{"description":"","pages":[]},"title":"List all Users","type":"endpoint","slug":"list-all-users","excerpt":"","body":"# Overview\n\nThis endpoint allows you to retrieve the name, email address, and user ID of your company's users in the Fountain system for all.","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5cd4c2fa0b10250037bc2926","project":"59de6011debd1200240f68ec","version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["59de6011debd1200240f68fb","59de6011debd1200240f68fa","59de6011debd1200240f68fc","59de6011debd1200240f68f8","59de6011debd1200240f68f7","59de6011debd1200240f68f9","59de6011debd1200240f68fd","59de6011debd1200240f68fe","59de6011debd1200240f68ff","5a8bfb99f4146e00449cec47","5a8bfcf2e86f530012159bb2","5cd4c29c6ea1040056ec0f55"],"_id":"59de6011debd1200240f68ee","__v":3,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:15:42.514Z","releaseDate":"2016-06-20T18:15:42.514Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Users","slug":"users","order":11,"from_sync":false,"reference":false,"_id":"5cd4c29c6ea1040056ec0f55","project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","createdAt":"2019-05-10T00:15:24.084Z","__v":0},"user":"59de7cde035e0d002eaefabe","createdAt":"2019-05-10T00:16:58.126Z","__v":6,"parentDoc":null}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

api_token:
required
stringsecret-api-token
Required if api_token is not passed in header

Examples


Result Format


Documentation

# Overview This endpoint allows you to retrieve the name, email address, and user ID of your company's users in the Fountain system for all.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}