Users

get users

GEThttps://ushahididocs.api.ushahidi.io/api/v3/users

Query parameters

Response

200401

OK

Body

application/json

countinteger

resultarray of UsersResponseList_result (object)

limitinteger

offsetinteger

orderstring

orderbystring

currstring

nextstring

prevstring

total_countinteger

Request

JavaScriptCurlPython

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/users', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "count": 0,
  "result": [
    {
      "id": 0,
      "url": "text",
      "email": "text",
      "realname": "text",
      "logins": 0,
      "failed_attempts": 0,
      "last_login": "text",
      "last_attempt": "text",
      "created": "text",
      "updated": "text",
      "role": "text",
      "language": "text",
      "contacts": [
        {
          "id": "text",
          "user_id": "text",
          "data_source": "text",
          "type": "text",
          "contact": "text",
          "created": "text",
          "updated": "text",
          "can_notify": "text"
        }
      ],
      "allowed_privileges": [
        "text"
      ],
      "gravatar": "text"
    }
  ],
  "limit": 0,
  "offset": 0,
  "order": "text",
  "orderby": "text",
  "curr": "text",
  "next": "text",
  "prev": "text",
  "total_count": 0
}

add user

POST https://ushahididocs.api.ushahidi.io/api/v3/users

Request Body

Name	Type	Description
email	String	The user's email address
failed_attempts	Integer	Number of failed attempts
logins	integer	Number of login attempts
realname	String	The user's real name
password	String	The user's password
last_attempt	String	Date of previous login attempt
last_login	String	Last login date
gravatar	String	The user's gravatar
role	String	user's roleString

200: OK

{
  "id": 0,
  "url": "string",
  "email": "string",
  "realname": "string",
  "logins": 0,
  "failed_attempts": 0,
  "last_login": "string",
  "last_attempt": "string",
  "created": "string",
  "updated": "string",
  "role": "string",
  "language": "string",
  "contacts": [
    {
      "id": "string",
      "user_id": "string",
      "data_source": "string",
      "type": "string",
      "contact": "string",
      "created": "string",
      "updated": "string",
      "can_notify": "string"
    }
  ],
  "allowed_privileges": [
    "string"
  ],
  "gravatar": "string"
}

get user

GEThttps://ushahididocs.api.ushahidi.io/api/v3/users/3

Response

200401404

OK

Body

application/json

idinteger

urlstring

emailstring

realnamestring

loginsinteger

failed_attemptsinteger

last_loginstring

last_attemptstring

createdstring

updatedstring

rolestring

languagestring

contactsarray of UsersResponseList_contacts (object)

allowed_privilegesarray of string

gravatarstring

Request

JavaScriptCurlPython

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/users/3', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "id": 0,
  "url": "text",
  "email": "text",
  "realname": "text",
  "logins": 0,
  "failed_attempts": 0,
  "last_login": "text",
  "last_attempt": "text",
  "created": "text",
  "updated": "text",
  "role": "text",
  "language": "text",
  "contacts": [
    {
      "id": "text",
      "user_id": "text",
      "data_source": "text",
      "type": "text",
      "contact": "text",
      "created": "text",
      "updated": "text",
      "can_notify": "text"
    }
  ],
  "allowed_privileges": [
    "text"
  ],
  "gravatar": "text"
}

edit user

PUT https://ushahididocs.api.ushahidi.io/api/v3/users/1

Request Body

Name	Type	Description
email	String	The user's email address
failed_attempts	Integer	Number of failed attempts
logins	integer	Number of login attempts
realname	String	The user's real name
password	String	The user's password
last_attempt	String	Date of previous login attempt
last_login	String	Last login date
gravatar	String	The user's gravatar
role	String	user's roleString

200: OK

{
  "id": 0,
  "url": "string",
  "email": "string",
  "realname": "string",
  "logins": 0,
  "failed_attempts": 0,
  "last_login": "string",
  "last_attempt": "string",
  "created": "string",
  "updated": "string",
  "role": "string",
  "language": "string",
  "contacts": [
    {
      "id": "string",
      "user_id": "string",
      "data_source": "string",
      "type": "string",
      "contact": "string",
      "created": "string",
      "updated": "string",
      "can_notify": "string"
    }
  ],
  "allowed_privileges": [
    "string"
  ],
  "gravatar": "string"
}

edit admin user

PUT https://ushahididocs.api.ushahidi.io/api/v3/users/me

Request Body

Name	Type	Description
email	String	The user's email address
failed_attempts	Integer	Number of failed attempts
logins	integer	Number of login attempts
realname	String	The user's real name
password	String	The user's password
last_attempt	String	Date of previous login attempt
last_login	String	Last login date
gravatar	String	The user's gravatar
role	String	user's roleString

200: OK

{
  "id": 0,
  "url": "string",
  "email": "string",
  "realname": "string",
  "logins": 0,
  "failed_attempts": 0,
  "last_login": "string",
  "last_attempt": "string",
  "created": "string",
  "updated": "string",
  "role": "string",
  "language": "string",
  "contacts": [
    {
      "id": "string",
      "user_id": "string",
      "data_source": "string",
      "type": "string",
      "contact": "string",
      "created": "string",
      "updated": "string",
      "can_notify": "string"
    }
  ],
  "allowed_privileges": [
    "string"
  ],
  "gravatar": "string"
}

delete user

DELETEhttps://ushahididocs.api.ushahidi.io/api/v3/users/80

Response

200404

OK

Body

application/json

idinteger

urlstring

emailstring

realnamestring

loginsinteger

failed_attemptsinteger

last_loginstring

last_attemptstring

createdstring

updatedstring

rolestring

languagestring

contactsarray of UsersResponseList_contacts (object)

allowed_privilegesarray of string

gravatarstring

Request

JavaScriptCurlPython

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/users/80', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "id": 0,
  "url": "text",
  "email": "text",
  "realname": "text",
  "logins": 0,
  "failed_attempts": 0,
  "last_login": "text",
  "last_attempt": "text",
  "created": "text",
  "updated": "text",
  "role": "text",
  "language": "text",
  "contacts": [
    {
      "id": "text",
      "user_id": "text",
      "data_source": "text",
      "type": "text",
      "contact": "text",
      "created": "text",
      "updated": "text",
      "can_notify": "text"
    }
  ],
  "allowed_privileges": [
    "text"
  ],
  "gravatar": "text"
}

get account/admin user

GEThttps://ushahididocs.api.ushahidi.io/api/v3/users/me

Response

200401

OK

Body

application/json

idinteger

urlstring

emailstring

realnamestring

loginsinteger

failed_attemptsinteger

last_loginstring

last_attemptstring

createdstring

updatedstring

rolestring

languagestring

contactsarray of UsersResponseList_contacts (object)

allowed_privilegesarray of string

gravatarstring

Request

JavaScriptCurlPython

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/users/me', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "id": 0,
  "url": "text",
  "email": "text",
  "realname": "text",
  "logins": 0,
  "failed_attempts": 0,
  "last_login": "text",
  "last_attempt": "text",
  "created": "text",
  "updated": "text",
  "role": "text",
  "language": "text",
  "contacts": [
    {
      "id": "text",
      "user_id": "text",
      "data_source": "text",
      "type": "text",
      "contact": "text",
      "created": "text",
      "updated": "text",
      "can_notify": "text"
    }
  ],
  "allowed_privileges": [
    "text"
  ],
  "gravatar": "text"
}