API Documentation
post
https://ushahididocs.api.ushahidi.io
/oauth/token
Get an authorization code for the client (without a user login)
post
https://ushahididocs.api.ushahidi.io
/oauth/token
Get an authorization code for a user
post
https://ushahididocs.api.ushahidi.io
/api/v3/passwordreset
Request a password reset token to be sent via email
post
https://ushahididocs.api.ushahidi.io
/api/v3/passwordreset/confirm
Reset your password with the reset token
post
https://ushahididocs.api.ushahidi.io
/api/v3/register
Register a new user
get
https://ushahididocs.api.ushahidi.io
/api/v3/collections
Get Collections
get
https://ushahididocs.api.ushahidi.io
/api/v3/posts?order=desc&orderby=created&set=15
Get Posts from a collection
post
https://ushahididocs.api.ushahidi.io
/api/v3/collections
Create a collection
delete
https://ushahididocs.api.ushahidi.io
/api/v3/collections/:collectionId
Delete a collection
get
https://ushahididocs.api.ushahidi.io
/api/v3/config
get
https://ushahididocs.api.ushahidi.io
/api/v3/contacts/:contactId
get
https://ushahididocs.api.ushahidi.io
/api/v3/country-codes
Get country codes

CSV Exports and Imports

get
https://ushahididocs.api.ushahidi.io
/api/v3/exports/jobs?user=me
Get a list of CSV exports jobs
put
https://ushahididocs.api.ushahidi.io
/api/v3/csv/:id/import
[WIP]Create metadata to start a CSV Import

Dataproviders (Datasources in the UI, read only config)

get
https://ushahididocs.api.ushahidi.io
/api/v3/dataproviders/[:id]
Get data provider options

Forms (Surveys)

get
https://ushahididocs.api.ushahidi.io
/api/v3/forms
Get all surveys
get
https://ushahididocs.api.ushahidi.io
/api/v3/forms/:id
Get all options for one survey
get
https://ushahididocs.api.ushahidi.io
/api/v3/forms/:id/attributes
Get all attributes (fields) for one survey
get
https://ushahididocs.api.ushahidi.io
/api/v3/forms/:id/stages
Get all stages (groups of fields) for one survey
get
https://ushahididocs.api.ushahidi.io
/api/v3/forms/:id/stats
Get stats (usage data) for one survey
get
https://ushahididocs.api.ushahidi.io
/api/v3/forms/:id/roles
Get all roles assigned to one survey
post
https://ushahididocs.api.ushahidi.io
/api/v3/forms
Create a survey
put
https://ushahididocs.api.ushahidi.io
/api/v3/forms/:form_id
Update a survey (example adding a new field)
delete
https://ushahididocs.api.ushahidi.io
/api/v3/forms/:form_id
Delete a survey
post
https://ushahididocs.api.ushahidi.io
/api/v3/messages
Respond to datasource messages
get
https://ushahididocs.api.ushahidi.io
/api/v3/messages
Get all messages for a post's contact
get
https://ushahididocs.api.ushahidi.io
/api/v3/messages/:messageId/post
Get the post for a message
post
https://ushahididocs.api.ushahidi.io
/api/v3/posts
Create a new post
Example payload:
{"title":"My title","content":"My content","values":{},"form":{"id":4}}
get
https://ushahididocs.api.ushahidi.io
/api/v3/posts
Get Posts
Copy link
On this page
post
Get an authorization code for the client (without a user login)
post
Get an authorization code for a user
post
Request a password reset token to be sent via email
post
Reset your password with the reset token
post
Register a new user
get
Get Collections
get
Get Posts from a collection
post
Create a collection
delete
Delete a collection
get
get
get
Get country codes
CSV Exports and Imports
get
Get a list of CSV exports jobs
put
[WIP]Create metadata to start a CSV Import
Dataproviders (Datasources in the UI, read only config)
get
Get data provider options
Forms (Surveys)
get
Get all surveys
get
Get all options for one survey
get
Get all attributes (fields) for one survey
get
Get all stages (groups of fields) for one survey
get
Get stats (usage data) for one survey
get
Get all roles assigned to one survey
post
Create a survey
put
Update a survey (example adding a new field)
delete
Delete a survey
post
Respond to datasource messages
get
Get all messages for a post's contact
get
Get the post for a message
post
Create a new post
get
Get Posts