Minsh apps API documentation v8

Preamble

Welcome! This API follows the REST paradigm with input and output data formatted in standard JSON following these best practices.

Each HTTP verb is used in the following way:

Verb	Semantic
`POST`	create a new resource, e.g., creating a user, shout or event
`GET`	retrieve a particular resource or a set of resources, e.g., retrieving a specific users or all users
`PUT`	update a particular resource, e.g., updating the username of a user
`DELETE`	destroy a particular resource, e.g., destroying a shout

Database

MongoDB is used as persistence layer. Any id used in the API is a MongoDB Object Id. See MongoDB documention for more details.

Tokens

Authentication tokens are UUID version 4, e.g., f47ac10b-58cc-4372-a567-0e02b2c3d479.

Acquisition and validity of tokens

Each time a user do a PUT /@app/users/login, she will get back an authentication token in return. Each token is then valid until the user explicitly logs out from the app or 18 months has passed (whichever happens first).

Endpoints

Each app is hosted as close as possible to its community users, choose your backend:

Continent	Endpoint
ASIA	`https://api8.min.sh/{app_name}/`
EUROPE	`https://api8-eu.min.sh/{app_name}/`
US	`https://api8-us.min.sh/{app_name}/`
SEOUL	`https://api8-seoul.min.sh/{app_name}/`

If the app backend is executed from a dedicated server, the endpoint looks like this: https://api8-{app_name}.min.sh/{app_name}.

HTTP success/error codes

Each error is composed of a HTTP code and a human readable string, e.g., the response from an unsuccessful PUT /users/login could return a HTTP code 400 with the following JSON response:

{"code":"BadRequestError","message":"USERNAME_OR_PASSWORD_NOT_CORRECT"}

Here are the main HTTP codes used in this API:

Code	Semantic
`200`	GET, PUT, DELETE success
`201`	POST success
`400`	Type for general bad request from client
`401`	Type when the token is invalid
`403`	Type when the user is forbidden to access
`429`	Type when the rate limit is exceeded
`500`	Type when there is an internal error

Rate limits

To avoid overloading the API server, requests are rate-limited. The default rate limit is 20 requests per 5 min. If you need more resources, please contact us.

FAQ

How to login directly with a `token` on the web client?

Sometimes, you already have a valid token for a user and you want to bypass the login screen. It is possible to do so by appending the token in the query string part of the web client url. Here is an example:

https://{app_name}.minsh.com/app.html#/main?token=d7bd5aca-e05e-4e5e-93bd-13b17e7b5fdd

If the bypass is successful, the web client will directly enter the main page of the app. In case of error, an error dialog will appear saying that the session is expired.

Please not that this token bypass method will only be evaluated if no user is currently logged in, i.e., you need to properly log out before testing this method.

How to obtain bigger profile images?

Profile images are images with dimension 55px by 55px. To obtain a 230px by 230px profile image, you need to append the string _230 just before the extension. One exception is when the profile image is provided by gravatar.com, in that case you need to append the url with the string &s=230.

Here is some JavaScript code to illustrate how to obtain the bigger profile image:

/* get big avatar url */
function getBigProfileImageUrl(url) {    
  /* early exit for gravatar profile images */
  if (url.indexOf('gravatar.com') !== -1) { return url + '&s=230'; }

  /* handle case when user has uploaded image */
  var lastIndexOfDot = url.lastIndexOf('.');
  return url.slice(0, lastIndexOfDot) + '_230' + url.slice(lastIndexOfDot);
}

The following sample code should help get you started.

<?php 
  $data = array('username_or_email'=>'johndoe','password'=>'secret');
  $data_json = json_encode($data);

  $ch = curl_init();
  curl_setopt($ch, CURLOPT_URL, 'https://endpoint/app/users/login');
  curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json','Content-Length: ' . strlen($data_json)));
  curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
  curl_setopt($ch, CURLOPT_POSTFIELDS, $data_json);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

  $response = curl_exec($ch);
  echo $response;

  curl_close($ch);
?>

The first step is to use the app to create the necessary groups.

Second, you can programmatically retrieve the groups using GET /{app_name}/groups with a valid token. For this step, using an admin token is advisable to ensure you get the entire list of groups. See below a sample output after getting the groups. Note that each group has an id field.

[
  {
    "id":"56d7d501d943bf19458889d1",
    "title":"Switzerland",
    "color":"#d27878",
    "icon":"plug",
    "owner":"569f924cb86fcd3471be30b1",
    "last_updated":"2016-08-16T10:56:48.376Z",
    "created":"2016-03-03T06:09:05.344Z",
    "total_users":22
  },
  {
    "id":"575a7a3f789a775e11bc4c30",
    "title":"India",
    "color":"#a59281",
    "icon":"group",
    "owner":"571a1250de9484f63e8db4ac",
    "last_updated":"2016-07-28T21:00:12.324Z",
    "created":"2016-06-10T08:28:47.655Z",
    "total_users":10
  }
]

Third, when you signup a new user with the API, use the POST /{app_name}/users request with the optional groups parameter filled with an array of group ids. Here is an example using the curl command-line tool:

curl -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{"email":"test@minsh.net", "fullname":"test is my name", "username":"test", "password":"xxx", "groups":["575a7a3f789a775e11bc4c30", "56d7d501d943bf19458889d1"]}' https://{endpoint}/{app_name}/users

The new user with username test is now created and has been automatically added to the provided groups ids corresponding to Switzerland and India.

API requests

Click on any request to expand it and see details.

URL parameters

app App string between 1 and 25 characters/[a-z0-9_-]{1,25}/

Required parameters

`token`	`/\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i`
`username`	Username string between 1 and 25 characters.`/^[a-z0-9_]{1,25}$/i`
`email`	Email.`/^(^(?=.{1,64}@)(?:[0-9a-z](?:[-+.a-zA-Z0-9_]{0,62}[a-zA-Z0-9_])?\|\)@(?:[0-9a-z][-\w]\.)+[a-z]{2,63}$)$/i`
`password`	`/^.{3,50}$/`

Optional parameters

`fullname`	Fullname of user`/^.{0,140}$/`
`groups`	Array of groups`/^(?:[\s\S])+$/`
`image_url`	URL of an image or empty string to reset it`/^$\|(?:https?:\/\/)[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?/i`
`admin`	Boolean`/^(true)\|(false)$/i`
`description`	Any string (even empty) will do for description within 500 chars limit`/^[\s\S]{0,500}$/`
`tags`	Any string (even empty) will do for tags within 500 chars limit`/^[\s\S]{0,500}$/`
`phone`	Phone number`/^\+?[0-9\-()/. ]*$/`
`url`	Url with optional protocol or empty string to reset it`/^$\|(?:https?:\/\/)?[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?/i`
`city`	City of the user`/^[\s\S]{0,250}$/`
`job`	Job of user`/^.{0,140}$/`
`address`	Address of the user`/^[\s\S]{0,250}$/`
`user_type`	Type of the user`/^.{0,140}$/`
`custom_field_0`	Custom field 0`/^[\s\S]{0,1000}$/`
`custom_field_1`	Custom field 1`/^[\s\S]{0,1000}$/`
`custom_field_2`	Custom field 2`/^[\s\S]{0,1000}$/`
`custom_field_3`	Custom field 3`/^[\s\S]{0,500}$/`
`company`	Company of the user`/^.{0,140}$/`
`workplace`	Workplace id`/[0-9a-fA-F]{24}/`
`pn_shout`	Push notification flag when someone shouts to everybody`/^(true)\|(false)$/i`
`pn_event`	Push notification flag when a new event is created`/^(true)\|(false)$/i`
`pn_sponsor`	Push notification flag when a new sponsor is created`/^(true)\|(false)$/i`
`pn_sponsors`	Map of namespace to boolean for sponsor notifications`/^\{("[0-9a-zA-Z-_]+":\s(true\|false),?\s)*\}$/i`
`pn_file`	Push notification flag when a new file is uploaded`/^(true)\|(false)$/i`
`geo`	Array of longitude and latitude`/.+/i`
`skip_creation_state`	skip creation state boolean flag`/^(true)\|(false)$/i`

Errors

BadRequestError: MISSING_TOKEN

BadRequestError: INVALID_TOKEN

BadRequestError: MISSING_USERNAME

BadRequestError: INVALID_USERNAME

BadRequestError: MISSING_EMAIL

BadRequestError: INVALID_EMAIL

BadRequestError: MISSING_PASSWORD

BadRequestError: INVALID_PASSWORD

BadRequestError: INVALID_FULLNAME

BadRequestError: INVALID_GROUPS

BadRequestError: INVALID_IMAGE_URL

BadRequestError: INVALID_ADMIN

BadRequestError: INVALID_DESCRIPTION

BadRequestError: INVALID_TAGS

BadRequestError: INVALID_PHONE

BadRequestError: INVALID_URL

BadRequestError: INVALID_CITY

BadRequestError: INVALID_JOB

BadRequestError: INVALID_ADDRESS

BadRequestError: INVALID_USER_TYPE

BadRequestError: INVALID_CUSTOM_FIELD_0

BadRequestError: INVALID_CUSTOM_FIELD_1

BadRequestError: INVALID_CUSTOM_FIELD_2

BadRequestError: INVALID_CUSTOM_FIELD_3

BadRequestError: INVALID_COMPANY

BadRequestError: INVALID_WORKPLACE

BadRequestError: INVALID_PN_SHOUT

BadRequestError: INVALID_PN_EVENT

BadRequestError: INVALID_PN_SPONSOR

BadRequestError: INVALID_PN_SPONSORS

BadRequestError: INVALID_PN_FILE

BadRequestError: INVALID_GEO

BadRequestError: INVALID_SKIP_CREATION_STATE

URL parameters

app App string between 1 and 25 characters/[a-z0-9_-]{1,25}/

Required parameters

`token`	`/\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i`
`title`	title`/^[\s\S]{1,140}$/`
`when`	scheduled start date of event (UNIX timestamp in ms)`/[0-9]+/`

Optional parameters

`geo`	Array of longitude and latitude`/.+/i`
`where`	venue of the event or empty string to reset it`/^$\|^[\s\S]{1,1000}$/`
`image`	URL of an image or empty string to reset it`/^$\|(?:https?:\/\/)[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?/i`
`file`	file structure`/[\s\S]*/`
`image_urls`	Array of image URLs`/^\[("(?:https?:\/\/)[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?",?)+\]$/i`
`files`	Array of file structures`/[\s\S]*/`
`registration_url`	Email (optional mailto: prefix), URL (optional protocol), or empty string.`/^$\|((?:mailto:)?^(?=.{1,64}@)(?:[0-9a-z](?:[-+.a-zA-Z0-9_]{0,62}[a-zA-Z0-9_])?\|\)@(?:[0-9a-z][-\w]\.)+[a-z]{2,63}$)\|((?:https?:\/\/)?[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?)$/i`
`desc`	details of classified/due/event/sponsor/room or empty string to reset it`/^$\|^[\s\S]{1,2000}$/`
`end`	scheduled end date of event (UNIX timestamp in ms)`/^$\|[0-9]+/`
`group`	Group id`/^[0-9a-fA-F]{24}$/i`
`color`	# hexadecimal color`/^[\s\S]{7}$/`
`organizer`	organizer username`/^[a-z0-9_]{1,25}$/i`
`workplace`	Workplace id`/[0-9a-fA-F]{24}/`

Errors

BadRequestError: MISSING_TOKEN

BadRequestError: INVALID_TOKEN

BadRequestError: MISSING_TITLE

BadRequestError: INVALID_TITLE

BadRequestError: MISSING_WHEN

BadRequestError: INVALID_WHEN

BadRequestError: INVALID_GEO

BadRequestError: INVALID_WHERE

BadRequestError: INVALID_IMAGE

BadRequestError: INVALID_FILE

BadRequestError: INVALID_IMAGE_URLS

BadRequestError: INVALID_FILES

BadRequestError: INVALID_REGISTRATION_URL

BadRequestError: INVALID_DESC

BadRequestError: INVALID_END

BadRequestError: INVALID_GROUP

BadRequestError: INVALID_COLOR

BadRequestError: INVALID_ORGANIZER

BadRequestError: INVALID_WORKPLACE

URL parameters

app App string between 1 and 25 characters/[a-z0-9_-]{1,25}/

Required parameters

`token`	`/\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i`
`title`	title`/^[\s\S]{1,140}$/`

Optional parameters

`desc`	details of classified/due/event/sponsor/room or empty string to reset it`/^$\|^[\s\S]{1,2000}$/`
`geo`	Array of longitude and latitude`/.+/i`
`capacity`	number of seats`/^[\s\S]{1,250}$/`
`equipment`	available equipment in a room`/^$\|^[\s\S]{1,1000}$/`
`city`	City of the user`/^[\s\S]{0,250}$/`
`building`	building location details`/^[\s\S]{1,250}$/`
`price`	price description`/^[\s\S]{1,250}$/`
`cancellation_delay`	number of hours prior to a booking during which a cancellation is permitted. 0 = no cancellation, -1 = any time.`/^[+-]?(0\|[1-9]\d*)$/`
`admin_confirmation_required`	whether admin confirmation is required`/^(true)\|(false)$/i`
`url`	Url with optional protocol or empty string to reset it`/^$\|(?:https?:\/\/)?[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?/i`
`door_code`	code to open the door`/^[\s\S]{1,140}$/`
`image_urls`	Array of image URLs`/^\[("(?:https?:\/\/)[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?",?)+\]$/i`
`files`	Array of file structures`/[\s\S]*/`
`group`	Group id`/^[0-9a-fA-F]{24}$/i`
`workplace`	Workplace id`/[0-9a-fA-F]{24}/`

Errors

BadRequestError: MISSING_TOKEN

BadRequestError: INVALID_TOKEN

BadRequestError: MISSING_TITLE

BadRequestError: INVALID_TITLE

BadRequestError: INVALID_DESC

BadRequestError: INVALID_GEO

BadRequestError: INVALID_CAPACITY

BadRequestError: INVALID_EQUIPMENT

BadRequestError: INVALID_CITY

BadRequestError: INVALID_BUILDING

BadRequestError: INVALID_PRICE

BadRequestError: INVALID_CANCELLATION_DELAY

BadRequestError: INVALID_ADMIN_CONFIRMATION_REQUIRED

BadRequestError: INVALID_URL

BadRequestError: INVALID_DOOR_CODE

BadRequestError: INVALID_IMAGE_URLS

BadRequestError: INVALID_FILES

BadRequestError: INVALID_GROUP

BadRequestError: INVALID_WORKPLACE

URL parameters

app App string between 1 and 25 characters/[a-z0-9_-]{1,25}/

Required parameters

`title`	title`/^[\s\S]{1,140}$/`
`token`	`/\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i`

Optional parameters

`image_url`	URL of an image or empty string to reset it`/^$\|(?:https?:\/\/)[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?/i`
`file`	file structure`/[\s\S]*/`
`image_urls`	Array of image URLs`/^\[("(?:https?:\/\/)[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?",?)+\]$/i`
`files`	Array of file structures`/[\s\S]*/`
`color`	# hexadecimal color`/^[\s\S]{7}$/`
`desc`	details of classified/due/event/sponsor/room or empty string to reset it`/^$\|^[\s\S]{1,2000}$/`
`url`	Url with optional protocol or empty string to reset it`/^$\|(?:https?:\/\/)?[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?/i`
`url2`	Url with optional protocol or empty string to reset it`/^$\|(?:https?:\/\/)?[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?/i`
`tags`	Any string (even empty) will do for tags within 500 chars limit`/^[\s\S]{0,500}$/`
`email`	Email.`/^(^(?=.{1,64}@)(?:[0-9a-z](?:[-+.a-zA-Z0-9_]{0,62}[a-zA-Z0-9_])?\|\)@(?:[0-9a-z][-\w]\.)+[a-z]{2,63}$)$/i`
`phone`	Phone number`/^\+?[0-9\-()/. ]*$/`
`location`	details of event / sponsor or empty string to reset it`/^$\|^[\s\S]{1,1000}$/`
`twitter_handle`	`/[a-z0-9_]{1,25}/i`
`custom_field_0`	Custom field 0`/^[\s\S]{0,1000}$/`
`custom_field_1`	Custom field 1`/^[\s\S]{0,1000}$/`
`custom_field_2`	Custom field 2`/^[\s\S]{0,1000}$/`
`geo`	Array of longitude and latitude`/.+/i`
`group`	Group id`/^[0-9a-fA-F]{24}$/i`
`namespace`	Namespace string between 1 and 15 characters`/[a-z0-9_-]{1,25}/`
`workplace`	Workplace id`/[0-9a-fA-F]{24}/`

Errors

BadRequestError: MISSING_TITLE

BadRequestError: INVALID_TITLE

BadRequestError: MISSING_TOKEN

BadRequestError: INVALID_TOKEN

BadRequestError: INVALID_IMAGE_URL

BadRequestError: INVALID_FILE

BadRequestError: INVALID_IMAGE_URLS

BadRequestError: INVALID_FILES

BadRequestError: INVALID_COLOR

BadRequestError: INVALID_DESC

BadRequestError: INVALID_URL

BadRequestError: INVALID_URL2

BadRequestError: INVALID_TAGS

BadRequestError: INVALID_EMAIL

BadRequestError: INVALID_PHONE

BadRequestError: INVALID_LOCATION

BadRequestError: INVALID_TWITTER_HANDLE

BadRequestError: INVALID_CUSTOM_FIELD_0

BadRequestError: INVALID_CUSTOM_FIELD_1

BadRequestError: INVALID_CUSTOM_FIELD_2

BadRequestError: INVALID_GEO

BadRequestError: INVALID_GROUP

BadRequestError: INVALID_NAMESPACE

BadRequestError: INVALID_WORKPLACE

URL parameters

app App string between 1 and 25 characters/[a-z0-9_-]{1,25}/

Required parameters

`username`	Username string between 1 and 25 characters.`/^[a-z0-9_]{1,25}$/i`
`email`	Email.`/^(^(?=.{1,64}@)(?:[0-9a-z](?:[-+.a-zA-Z0-9_]{0,62}[a-zA-Z0-9_])?\|\)@(?:[0-9a-z][-\w]\.)+[a-z]{2,63}$)$/i`
`password`	`/^.{3,50}$/`

Optional parameters

`fullname`	Fullname of user`/^.{0,140}$/`
`groups`	Array of groups`/^(?:[\s\S])+$/`
`geo`	Array of longitude and latitude`/.+/i`
`workplace`	Workplace id`/[0-9a-fA-F]{24}/`
`preferred_lang`	Preferred language ISO code`/^.{2,10}$/i`
`description`	Any string (even empty) will do for description within 500 chars limit`/^[\s\S]{0,500}$/`
`tags`	Any string (even empty) will do for tags within 500 chars limit`/^[\s\S]{0,500}$/`
`phone`	Phone number`/^\+?[0-9\-()/. ]*$/`
`job`	Job of user`/^.{0,140}$/`
`address`	Address of the user`/^[\s\S]{0,250}$/`
`user_type`	Type of the user`/^.{0,140}$/`
`custom_field_0`	Custom field 0`/^[\s\S]{0,1000}$/`
`custom_field_1`	Custom field 1`/^[\s\S]{0,1000}$/`
`custom_field_2`	Custom field 2`/^[\s\S]{0,1000}$/`
`custom_field_3`	Custom field 3`/^[\s\S]{0,500}$/`
`url`	Url with optional protocol or empty string to reset it`/^$\|(?:https?:\/\/)?[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?/i`
`city`	City of the user`/^[\s\S]{0,250}$/`
`company`	Company of the user`/^.{0,140}$/`
`facebook`	Facebook's username`/^.{0,140}$/`
`linkedin`	Linkedin's username`/^.{0,140}$/`
`twitter`	Twitter's username`/^.{0,140}$/`
`snapchat`	Snapchat's username`/^.{0,140}$/`
`instagram`	Instagram's username`/^.{0,140}$/`
`read_only_0`	only visible to self and editable only by an admin`/^$\|([\s\S])+$/`
`read_only_1`	only visible to self and editable only by an admin`/^$\|([\s\S])+$/`
`read_only_2`	only visible to self and editable only by an admin`/^$\|([\s\S])+$/`
`badge`	Badge string (font awesome icon)`/^([\s\S]){1,50}$/`

Errors

BadRequestError: MISSING_USERNAME

BadRequestError: INVALID_USERNAME

BadRequestError: MISSING_EMAIL

BadRequestError: INVALID_EMAIL

BadRequestError: MISSING_PASSWORD

BadRequestError: INVALID_PASSWORD

BadRequestError: INVALID_FULLNAME

BadRequestError: INVALID_GROUPS

BadRequestError: INVALID_GEO

BadRequestError: INVALID_WORKPLACE

BadRequestError: INVALID_PREFERRED_LANG

BadRequestError: INVALID_DESCRIPTION

BadRequestError: INVALID_TAGS

BadRequestError: INVALID_PHONE

BadRequestError: INVALID_JOB

BadRequestError: INVALID_ADDRESS

BadRequestError: INVALID_USER_TYPE

BadRequestError: INVALID_CUSTOM_FIELD_0

BadRequestError: INVALID_CUSTOM_FIELD_1

BadRequestError: INVALID_CUSTOM_FIELD_2

BadRequestError: INVALID_CUSTOM_FIELD_3

BadRequestError: INVALID_URL

BadRequestError: INVALID_CITY

BadRequestError: INVALID_COMPANY

BadRequestError: INVALID_FACEBOOK

BadRequestError: INVALID_LINKEDIN

BadRequestError: INVALID_TWITTER

BadRequestError: INVALID_SNAPCHAT

BadRequestError: INVALID_INSTAGRAM

BadRequestError: INVALID_READ_ONLY_0

BadRequestError: INVALID_READ_ONLY_1

BadRequestError: INVALID_READ_ONLY_2

BadRequestError: INVALID_BADGE

URL parameters

app App string between 1 and 25 characters/[a-z0-9_-]{1,25}/

Required parameters

`additional_id`	additional ID for third party services`/^[\s\S]{1,140}$/`
`email`	Email.`/^(^(?=.{1,64}@)(?:[0-9a-z](?:[-+.a-zA-Z0-9_]{0,62}[a-zA-Z0-9_])?\|\)@(?:[0-9a-z][-\w]\.)+[a-z]{2,63}$)$/i`

Optional parameters

`username`	Username string between 1 and 25 characters.`/^[a-z0-9_]{1,25}$/i`
`fullname`	Fullname of user`/^.{0,140}$/`
`groups`	Array of groups`/^(?:[\s\S])+$/`
`geo`	Array of longitude and latitude`/.+/i`
`workplace`	Workplace id`/[0-9a-fA-F]{24}/`
`description`	Any string (even empty) will do for description within 500 chars limit`/^[\s\S]{0,500}$/`
`tags`	Any string (even empty) will do for tags within 500 chars limit`/^[\s\S]{0,500}$/`
`phone`	Phone number`/^\+?[0-9\-()/. ]*$/`
`job`	Job of user`/^.{0,140}$/`
`address`	Address of the user`/^[\s\S]{0,250}$/`
`user_type`	Type of the user`/^.{0,140}$/`
`custom_field_0`	Custom field 0`/^[\s\S]{0,1000}$/`
`custom_field_1`	Custom field 1`/^[\s\S]{0,1000}$/`
`custom_field_2`	Custom field 2`/^[\s\S]{0,1000}$/`
`custom_field_3`	Custom field 3`/^[\s\S]{0,500}$/`
`url`	Url with optional protocol or empty string to reset it`/^$\|(?:https?:\/\/)?[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?/i`
`city`	City of the user`/^[\s\S]{0,250}$/`
`company`	Company of the user`/^.{0,140}$/`
`facebook`	Facebook's username`/^.{0,140}$/`
`linkedin`	Linkedin's username`/^.{0,140}$/`
`twitter`	Twitter's username`/^.{0,140}$/`
`snapchat`	Snapchat's username`/^.{0,140}$/`
`instagram`	Instagram's username`/^.{0,140}$/`
`read_only_0`	only visible to self and editable only by an admin`/^$\|([\s\S])+$/`
`read_only_1`	only visible to self and editable only by an admin`/^$\|([\s\S])+$/`
`read_only_2`	only visible to self and editable only by an admin`/^$\|([\s\S])+$/`

Errors

BadRequestError: MISSING_ADDITIONAL_ID

BadRequestError: INVALID_ADDITIONAL_ID

BadRequestError: MISSING_EMAIL

BadRequestError: INVALID_EMAIL

BadRequestError: INVALID_USERNAME

BadRequestError: INVALID_FULLNAME

BadRequestError: INVALID_GROUPS

BadRequestError: INVALID_GEO

BadRequestError: INVALID_WORKPLACE

BadRequestError: INVALID_DESCRIPTION

BadRequestError: INVALID_TAGS

BadRequestError: INVALID_PHONE

BadRequestError: INVALID_JOB

BadRequestError: INVALID_ADDRESS

BadRequestError: INVALID_USER_TYPE

BadRequestError: INVALID_CUSTOM_FIELD_0

BadRequestError: INVALID_CUSTOM_FIELD_1

BadRequestError: INVALID_CUSTOM_FIELD_2

BadRequestError: INVALID_CUSTOM_FIELD_3

BadRequestError: INVALID_URL

BadRequestError: INVALID_CITY

BadRequestError: INVALID_COMPANY

BadRequestError: INVALID_FACEBOOK

BadRequestError: INVALID_LINKEDIN

BadRequestError: INVALID_TWITTER

BadRequestError: INVALID_SNAPCHAT

BadRequestError: INVALID_INSTAGRAM

BadRequestError: INVALID_READ_ONLY_0

BadRequestError: INVALID_READ_ONLY_1

BadRequestError: INVALID_READ_ONLY_2

URL parameters

`app`	App string between 1 and 25 characters`/[a-z0-9_-]{1,25}/`
`id`	Object id`/[0-9a-fA-F]{24}/`

Required parameters

token /\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i

Optional parameters

`geo`	Array of longitude and latitude`/.+/i`
`title`	title`/^[\s\S]{1,140}$/`
`when`	scheduled start date of event (UNIX timestamp in ms)`/[0-9]+/`
`where`	venue of the event or empty string to reset it`/^$\|^[\s\S]{1,1000}$/`
`image`	URL of an image or empty string to reset it`/^$\|(?:https?:\/\/)[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?/i`
`file`	file structure`/[\s\S]*/`
`image_urls`	Array of image URLs`/^\[("(?:https?:\/\/)[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?",?)+\]$/i`
`files`	Array of file structures`/[\s\S]*/`
`registration_url`	Email (optional mailto: prefix), URL (optional protocol), or empty string.`/^$\|((?:mailto:)?^(?=.{1,64}@)(?:[0-9a-z](?:[-+.a-zA-Z0-9_]{0,62}[a-zA-Z0-9_])?\|\)@(?:[0-9a-z][-\w]\.)+[a-z]{2,63}$)\|((?:https?:\/\/)?[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?)$/i`
`desc`	details of classified/due/event/sponsor/room or empty string to reset it`/^$\|^[\s\S]{1,2000}$/`
`group`	Group id`/^[0-9a-fA-F]{24}$/i`
`end`	scheduled end date of event (UNIX timestamp in ms)`/^$\|[0-9]+/`
`color`	# hexadecimal color`/^[\s\S]{7}$/`
`organizer`	organizer username`/^[a-z0-9_]{1,25}$/i`
`organizer_name`	organizer name string (app outsider)`/^$\|^[\s\S]{1,140}$/`
`remove_fields`	fields that can be removed`/^\[(?:"[a-z-_0-9]+"\|,)*\]$/gi`

Errors

BadRequestError: MISSING_TOKEN

BadRequestError: INVALID_TOKEN

BadRequestError: INVALID_GEO

BadRequestError: INVALID_TITLE

BadRequestError: INVALID_WHEN

BadRequestError: INVALID_WHERE

BadRequestError: INVALID_IMAGE

BadRequestError: INVALID_FILE

BadRequestError: INVALID_IMAGE_URLS

BadRequestError: INVALID_FILES

BadRequestError: INVALID_REGISTRATION_URL

BadRequestError: INVALID_DESC

BadRequestError: INVALID_GROUP

BadRequestError: INVALID_END

BadRequestError: INVALID_COLOR

BadRequestError: INVALID_ORGANIZER

BadRequestError: INVALID_ORGANIZER_NAME

BadRequestError: INVALID_REMOVE_FIELDS

URL parameters

`app`	App string between 1 and 25 characters`/[a-z0-9_-]{1,25}/`
`id`	Object id`/[0-9a-fA-F]{24}/`

Required parameters

token /\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i

Optional parameters

`geo`	Array of longitude and latitude`/.+/i`
`title`	title`/^[\s\S]{1,140}$/`
`desc`	details of classified/due/event/sponsor/room or empty string to reset it`/^$\|^[\s\S]{1,2000}$/`
`capacity`	number of seats`/^[\s\S]{1,250}$/`
`equipment`	available equipment in a room`/^$\|^[\s\S]{1,1000}$/`
`door_code`	code to open the door`/^[\s\S]{1,140}$/`
`city`	City of the user`/^[\s\S]{0,250}$/`
`building`	building location details`/^[\s\S]{1,250}$/`
`price`	price description`/^[\s\S]{1,250}$/`
`cancellation_delay`	number of hours prior to a booking during which a cancellation is permitted. 0 = no cancellation, -1 = any time.`/^[+-]?(0\|[1-9]\d*)$/`
`admin_confirmation_required`	whether admin confirmation is required`/^(true)\|(false)$/i`
`url`	Url with optional protocol or empty string to reset it`/^$\|(?:https?:\/\/)?[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?/i`
`files`	Array of file structures`/[\s\S]*/`
`image_urls`	Array of image URLs`/^\[("(?:https?:\/\/)[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?",?)+\]$/i`
`remove_fields`	fields that can be removed`/^\[(?:"[a-z-_0-9]+"\|,)*\]$/gi`

Errors

BadRequestError: MISSING_TOKEN

BadRequestError: INVALID_TOKEN

BadRequestError: INVALID_GEO

BadRequestError: INVALID_TITLE

BadRequestError: INVALID_DESC

BadRequestError: INVALID_CAPACITY

BadRequestError: INVALID_EQUIPMENT

BadRequestError: INVALID_DOOR_CODE

BadRequestError: INVALID_CITY

BadRequestError: INVALID_BUILDING

BadRequestError: INVALID_PRICE

BadRequestError: INVALID_CANCELLATION_DELAY

BadRequestError: INVALID_ADMIN_CONFIRMATION_REQUIRED

BadRequestError: INVALID_URL

BadRequestError: INVALID_FILES

BadRequestError: INVALID_IMAGE_URLS

BadRequestError: INVALID_REMOVE_FIELDS

URL parameters

`app`	App string between 1 and 25 characters`/[a-z0-9_-]{1,25}/`
`id`	Object id`/[0-9a-fA-F]{24}/`

Required parameters

token /\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i

Optional parameters

`geo`	Array of longitude and latitude`/.+/i`
`created`	creation date (UNIX timestamp in ms)`/^$\|[0-9]+/`
`title`	title`/^[\s\S]{1,140}$/`
`image_url`	URL of an image or empty string to reset it`/^$\|(?:https?:\/\/)[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?/i`
`image_urls`	Array of image URLs`/^\[("(?:https?:\/\/)[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?",?)+\]$/i`
`color`	# hexadecimal color`/^[\s\S]{7}$/`
`file`	file structure`/[\s\S]*/`
`files`	Array of file structures`/[\s\S]*/`
`desc`	details of classified/due/event/sponsor/room or empty string to reset it`/^$\|^[\s\S]{1,2000}$/`
`url`	Url with optional protocol or empty string to reset it`/^$\|(?:https?:\/\/)?[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?/i`
`url2`	Url with optional protocol or empty string to reset it`/^$\|(?:https?:\/\/)?[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?/i`
`tags`	Any string (even empty) will do for tags within 500 chars limit`/^[\s\S]{0,500}$/`
`email`	Email.`/^(^(?=.{1,64}@)(?:[0-9a-z](?:[-+.a-zA-Z0-9_]{0,62}[a-zA-Z0-9_])?\|\)@(?:[0-9a-z][-\w]\.)+[a-z]{2,63}$)$/i`
`phone`	Phone number`/^\+?[0-9\-()/. ]*$/`
`twitter_handle`	`/[a-z0-9_]{1,25}/i`
`custom_field_0`	Custom field 0`/^[\s\S]{0,1000}$/`
`custom_field_1`	Custom field 1`/^[\s\S]{0,1000}$/`
`custom_field_2`	Custom field 2`/^[\s\S]{0,1000}$/`
`location`	details of event / sponsor or empty string to reset it`/^$\|^[\s\S]{1,1000}$/`
`remove_fields`	fields that can be removed`/^\[(?:"[a-z-_0-9]+"\|,)*\]$/gi`

Errors

BadRequestError: MISSING_TOKEN

BadRequestError: INVALID_TOKEN

BadRequestError: INVALID_GEO

BadRequestError: INVALID_CREATED

BadRequestError: INVALID_TITLE

BadRequestError: INVALID_IMAGE_URL

BadRequestError: INVALID_IMAGE_URLS

BadRequestError: INVALID_COLOR

BadRequestError: INVALID_FILE

BadRequestError: INVALID_FILES

BadRequestError: INVALID_DESC

BadRequestError: INVALID_URL

BadRequestError: INVALID_URL2

BadRequestError: INVALID_TAGS

BadRequestError: INVALID_EMAIL

BadRequestError: INVALID_PHONE

BadRequestError: INVALID_TWITTER_HANDLE

BadRequestError: INVALID_CUSTOM_FIELD_0

BadRequestError: INVALID_CUSTOM_FIELD_1

BadRequestError: INVALID_CUSTOM_FIELD_2

BadRequestError: INVALID_LOCATION

BadRequestError: INVALID_REMOVE_FIELDS

URL parameters

`app`	App string between 1 and 25 characters`/[a-z0-9_-]{1,25}/`
`id`	Object id`/[0-9a-fA-F]{24}/`

Required parameters

token /\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i

Optional parameters

`geo`	Array of longitude and latitude`/.+/i`
`username`	Username string between 1 and 25 characters.`/^[a-z0-9_]{1,25}$/i`
`email`	Email.`/^(^(?=.{1,64}@)(?:[0-9a-z](?:[-+.a-zA-Z0-9_]{0,62}[a-zA-Z0-9_])?\|\)@(?:[0-9a-z][-\w]\.)+[a-z]{2,63}$)$/i`
`fullname`	Fullname of user`/^.{0,140}$/`
`admin`	Boolean`/^(true)\|(false)$/i`
`description`	Any string (even empty) will do for description within 500 chars limit`/^[\s\S]{0,500}$/`
`tags`	Any string (even empty) will do for tags within 500 chars limit`/^[\s\S]{0,500}$/`
`phone`	Phone number`/^\+?[0-9\-()/. ]*$/`
`url`	Url with optional protocol or empty string to reset it`/^$\|(?:https?:\/\/)?[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?/i`
`city`	City of the user`/^[\s\S]{0,250}$/`
`job`	Job of user`/^.{0,140}$/`
`address`	Address of the user`/^[\s\S]{0,250}$/`
`user_type`	Type of the user`/^.{0,140}$/`
`custom_field_0`	Custom field 0`/^[\s\S]{0,1000}$/`
`custom_field_1`	Custom field 1`/^[\s\S]{0,1000}$/`
`custom_field_2`	Custom field 2`/^[\s\S]{0,1000}$/`
`custom_field_3`	Custom field 3`/^[\s\S]{0,500}$/`
`company`	Company of the user`/^.{0,140}$/`
`password`	`/^.{3,50}$/`
`subscription`	Subscription is an object id which can be `null` if no subscription plan`/^(null)\|([0-9a-fA-F]{24})$/i`
`new_password`	`/^.{3,50}$/`
`pn_shout`	Push notification flag when someone shouts to everybody`/^(true)\|(false)$/i`
`pn_event`	Push notification flag when a new event is created`/^(true)\|(false)$/i`
`pn_sponsor`	Push notification flag when a new sponsor is created`/^(true)\|(false)$/i`
`pn_sponsors`	Map of namespace to boolean for sponsor notifications`/^\{("[0-9a-zA-Z-_]+":\s(true\|false),?\s)*\}$/i`
`pn_file`	Push notification flag when a new file is uploaded`/^(true)\|(false)$/i`
`pn_like`	Push notification flag when someone likes your content`/^(true)\|(false)$/i`
`pn_mention`	Push notification flag when someone mentions you`/^(true)\|(false)$/i`
`pn_booking`	Push notification flag when you have an upcoming booking`/^(true)\|(false)$/i`
`pn_classified`	Push notification flag when a new classified is posted`/^(true)\|(false)$/i`
`mailing_dm`	Mailing notification flag when someone sends me a private message`/^(true)\|(false)$/i`
`mailing_mention`	Mailing notification flag when someone mentions you`/^(true)\|(false)$/i`
`mailing_event`	Mailing notification flag when someone creates an event`/^(true)\|(false)$/i`
`mailing_important`	Mailing notification flag when admin send an #important message`/^(true)\|(false)$/i`
`mailing_booking`	Mailing notification flag when you have an upcoming booking`/^(true)\|(false)$/i`
`facebook`	Facebook's username`/^.{0,140}$/`
`linkedin`	Linkedin's username`/^.{0,140}$/`
`twitter`	Twitter's username`/^.{0,140}$/`
`snapchat`	Snapchat's username`/^.{0,140}$/`
`instagram`	Instagram's username`/^.{0,140}$/`
`badge`	Badge string (font awesome icon)`/^([\s\S]){1,50}$/`
`read_only_0`	only visible to self and editable only by an admin`/^$\|([\s\S])+$/`
`read_only_1`	only visible to self and editable only by an admin`/^$\|([\s\S])+$/`
`read_only_2`	only visible to self and editable only by an admin`/^$\|([\s\S])+$/`

Errors

BadRequestError: MISSING_TOKEN

BadRequestError: INVALID_TOKEN

BadRequestError: INVALID_GEO

BadRequestError: INVALID_USERNAME

BadRequestError: INVALID_EMAIL

BadRequestError: INVALID_FULLNAME

BadRequestError: INVALID_ADMIN

BadRequestError: INVALID_DESCRIPTION

BadRequestError: INVALID_TAGS

BadRequestError: INVALID_PHONE

BadRequestError: INVALID_URL

BadRequestError: INVALID_CITY

BadRequestError: INVALID_JOB

BadRequestError: INVALID_ADDRESS

BadRequestError: INVALID_USER_TYPE

BadRequestError: INVALID_CUSTOM_FIELD_0

BadRequestError: INVALID_CUSTOM_FIELD_1

BadRequestError: INVALID_CUSTOM_FIELD_2

BadRequestError: INVALID_CUSTOM_FIELD_3

BadRequestError: INVALID_COMPANY

BadRequestError: INVALID_PASSWORD

BadRequestError: INVALID_SUBSCRIPTION

BadRequestError: INVALID_NEW_PASSWORD

BadRequestError: INVALID_PN_SHOUT

BadRequestError: INVALID_PN_EVENT

BadRequestError: INVALID_PN_SPONSOR

BadRequestError: INVALID_PN_SPONSORS

BadRequestError: INVALID_PN_FILE

BadRequestError: INVALID_PN_LIKE

BadRequestError: INVALID_PN_MENTION

BadRequestError: INVALID_PN_BOOKING

BadRequestError: INVALID_PN_CLASSIFIED

BadRequestError: INVALID_MAILING_DM

BadRequestError: INVALID_MAILING_MENTION

BadRequestError: INVALID_MAILING_EVENT

BadRequestError: INVALID_MAILING_IMPORTANT

BadRequestError: INVALID_MAILING_BOOKING

BadRequestError: INVALID_FACEBOOK

BadRequestError: INVALID_LINKEDIN

BadRequestError: INVALID_TWITTER

BadRequestError: INVALID_SNAPCHAT

BadRequestError: INVALID_INSTAGRAM

BadRequestError: INVALID_BADGE

BadRequestError: INVALID_READ_ONLY_0

BadRequestError: INVALID_READ_ONLY_1

BadRequestError: INVALID_READ_ONLY_2

URL parameters

`app`	App string between 1 and 25 characters`/[a-z0-9_-]{1,25}/`
`additional_id`	additional ID for third party services`/^[\s\S]{1,140}$/`

Optional parameters

`email`	Email.`/^(^(?=.{1,64}@)(?:[0-9a-z](?:[-+.a-zA-Z0-9_]{0,62}[a-zA-Z0-9_])?\|\)@(?:[0-9a-z][-\w]\.)+[a-z]{2,63}$)$/i`
`fullname`	Fullname of user`/^.{0,140}$/`
`groups`	Array of groups`/^(?:[\s\S])+$/`
`workplace`	Workplace id`/[0-9a-fA-F]{24}/`
`description`	Any string (even empty) will do for description within 500 chars limit`/^[\s\S]{0,500}$/`
`tags`	Any string (even empty) will do for tags within 500 chars limit`/^[\s\S]{0,500}$/`
`phone`	Phone number`/^\+?[0-9\-()/. ]*$/`
`job`	Job of user`/^.{0,140}$/`
`address`	Address of the user`/^[\s\S]{0,250}$/`
`user_type`	Type of the user`/^.{0,140}$/`
`custom_field_0`	Custom field 0`/^[\s\S]{0,1000}$/`
`custom_field_1`	Custom field 1`/^[\s\S]{0,1000}$/`
`custom_field_2`	Custom field 2`/^[\s\S]{0,1000}$/`
`custom_field_3`	Custom field 3`/^[\s\S]{0,500}$/`
`url`	Url with optional protocol or empty string to reset it`/^$\|(?:https?:\/\/)?[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?/i`
`city`	City of the user`/^[\s\S]{0,250}$/`
`company`	Company of the user`/^.{0,140}$/`
`facebook`	Facebook's username`/^.{0,140}$/`
`linkedin`	Linkedin's username`/^.{0,140}$/`
`twitter`	Twitter's username`/^.{0,140}$/`
`snapchat`	Snapchat's username`/^.{0,140}$/`
`instagram`	Instagram's username`/^.{0,140}$/`
`read_only_0`	only visible to self and editable only by an admin`/^$\|([\s\S])+$/`
`read_only_1`	only visible to self and editable only by an admin`/^$\|([\s\S])+$/`
`read_only_2`	only visible to self and editable only by an admin`/^$\|([\s\S])+$/`

Errors

BadRequestError: INVALID_EMAIL

BadRequestError: INVALID_FULLNAME

BadRequestError: INVALID_GROUPS

BadRequestError: INVALID_WORKPLACE

BadRequestError: INVALID_DESCRIPTION

BadRequestError: INVALID_TAGS

BadRequestError: INVALID_PHONE

BadRequestError: INVALID_JOB

BadRequestError: INVALID_ADDRESS

BadRequestError: INVALID_USER_TYPE

BadRequestError: INVALID_CUSTOM_FIELD_0

BadRequestError: INVALID_CUSTOM_FIELD_1

BadRequestError: INVALID_CUSTOM_FIELD_2

BadRequestError: INVALID_CUSTOM_FIELD_3

BadRequestError: INVALID_URL

BadRequestError: INVALID_CITY

BadRequestError: INVALID_COMPANY

BadRequestError: INVALID_FACEBOOK

BadRequestError: INVALID_LINKEDIN

BadRequestError: INVALID_TWITTER

BadRequestError: INVALID_SNAPCHAT

BadRequestError: INVALID_INSTAGRAM

BadRequestError: INVALID_READ_ONLY_0

BadRequestError: INVALID_READ_ONLY_1

BadRequestError: INVALID_READ_ONLY_2

`token`	`/\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i`
`name`	name`/^[\s\S]{1,140}$/`
`parent`	Parent is an object id which can be `null` for the root directory`/^(null)\|([0-9a-fA-F]{24})$/i`

`file_data`	Base64 encoded file`/[\s\S]/i`
`parent`	Parent is an object id which can be `null` for the root directory`/^(null)\|([0-9a-fA-F]{24})$/i`
`workplace`	Workplace id`/[0-9a-fA-F]{24}/`

`icon`	icon string`/^[\s\S]{1,140}$/`
`image_url`	URL of an image or empty string to reset it`/^$\|(?:https?:\/\/)[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?/i`
`users`	Array of user ids`/^[0-9a-fA-F]{24}(,[0-9a-fA-F]{24})*$/i`
`description`	Any string (even empty) will do for description within 500 chars limit`/^[\s\S]{0,500}$/`
`selected`	group selected boolean`/^(true)\|(false)$/i`
`workplace`	Workplace id`/[0-9a-fA-F]{24}/`
`invisible`	invisible group boolean`/^(true)\|(false)$/i`
`autojoin`	group auto join boolean`/^(true)\|(false)$/i`
`geo`	Array of longitude and latitude`/.+/i`

`type`	purchase type`/^([\s\S])+$/`
`password`	fovea password`/^([\s\S])+$/`

`applicationUsername`	fovea application username`/^([\s\S])+$/`
`purchases`	purchases`/^([\s\S])+$/`

`token`	`/\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i`
`shout`	Any string between 1 and 2000 chars will do it`/^[\s\S]+$/`

`token`	`/\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i`
`comment`	Any string between 1 and 2000 chars will do it`/^[\s\S]+$/`

`token`	`/\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i`
`rating`	Integer between 1 and 5`/^\+?(0\|[1-9]\d*)$/`

`msg`	non-empty msg`/[^\s\\]{1,1500}/im`
`token`	`/\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i`

`token`	`/\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i`
`emails`	Array of emails.`/[\s\S]{0,50000}/`

`page_name`	Page name to log between 1 and 25 characters alphanums only.`/^[a-z0-9_]{1,25}$/i`
`action`	Action name to log between 1 and 140 characters.`/^.{0,140}$/`

`image_data`	pattern for base64 encoded images`/[\s\S]/i`
`geo`	Array of longitude and latitude`/.+/i`

`token`	`/\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i`
`from`	ISODate UTC or Unix timestamp`/^(\+?(0\|[1-9]\d*))\|((\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(\.\d+)?Z)$/`
`to`	ISODate UTC or Unix timestamp`/^(\+?(0\|[1-9]\d*))\|((\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(\.\d+)?Z)$/`

`startDateUTC`	ISODate UTC`/(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(\.\d+)?Z/`
`endDateUTC`	ISODate UTC`/(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(\.\d+)?Z/`
`organizerId`	User id for Roomz server`/^[0-9a-fA-F]{24}$/i`

`geo`	Array of longitude and latitude`/.+/i`
`in_reply_to`	Mongo ObjectId`/[0-9a-fA-F]{24}/i`
`image_urls`	Array of image URLs`/^\[("(?:https?:\/\/)[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?",?)+\]$/i`
`files`	Array of file structures`/[\s\S]*/`
`image`	URL of an image or empty string to reset it`/^$\|(?:https?:\/\/)[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?/i`
`file`	file structure`/[\s\S]*/`
`recipients`	Array of user ids`/^\[("[0-9a-fA-F]{24}",?)+\]$/i`
`group`	Group id`/^[0-9a-fA-F]{24}$/i`
`workplace`	Workplace id`/[0-9a-fA-F]{24}/`
`poll_options`	Array of poll options (max 15 options, max 200 characters per option)`/[\s\S]*/`
`poll_multiple`	Whether multiple options can be selected`/^(true)\|(false)$/i`
`poll_private`	Whether poll results are private`/^(true)\|(false)$/i`
`poll_end`	Optional expiration date for the poll (ISODate UTC or Unix timestamp)`/^(\+?(0\|[1-9]\d*))\|((\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(\.\d+)?Z)$/`

`resources`	Array of resources`/^[0-9a-fA-F]{24}(,[0-9a-fA-F]{24})*$/i`
`geo`	Array of longitude and latitude`/.+/i`

`token`	`/\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i`
`before_date`	before date (UNIX timestamp in ms)`/^\+?(0\|[1-9]\d*)$/`
`after_date`	after date (UNIX timestamp in ms)`/^\+?(0\|[1-9]\d*)$/`

`company`	Company of the user`/^.{0,140}$/`
`room`	Room id`/^[0-9a-fA-F]{24}$/i`

`app`	App string between 1 and 25 characters`/[a-z0-9_-]{1,25}/`
`short random string`	Badge string (font awesome icon)`/^([\s\S]{2,15})$/`

`parent`	Parent is an object id which can be `null` for the root directory`/^(null)\|([0-9a-fA-F]{24})$/i`
`query`	search query string`/^[\s\S]{0,256}$/i`
`workplace`	Workplace id`/[0-9a-fA-F]{24}/`
`preferred_lang`	Preferred language ISO code`/^.{2,10}$/i`

`workplace`	Workplace id`/[0-9a-fA-F]{24}/`
`archive`	archive group boolean`/^(true)\|(false)$/i`
`preferred_lang`	Preferred language ISO code`/^.{2,10}$/i`

`preferred_lang`	Preferred language ISO code`/^.{2,10}$/i`
`page`	Page number`/^\+?(0\|[1-9]\d*)$/`
`count`	Number of items`/^\+?(0\|[1-9]\d*)$/`

`geo`	Array of longitude and latitude`/.+/i`
`before`	Mongo ObjectId`/[0-9a-fA-F]{24}/i`
`after`	Mongo ObjectId`/[0-9a-fA-F]{24}/i`
`count`	Number of items`/^\+?(0\|[1-9]\d*)$/`
`group`	Group id`/^[0-9a-fA-F]{24}$/i`
`filter`	Filter is a group or user id`/^0\|[0-9a-fA-F]{24}$/i`
`workplace`	Workplace id`/[0-9a-fA-F]{24}/`
`preferred_lang`	Preferred language ISO code`/^.{2,10}$/i`

`geo`	Array of longitude and latitude`/.+/i`
`verify_subscription`	`/^((true)\|(false))+$/`

`title`	title`/^[\s\S]{1,140}$/`
`category`	category of a classified`/^$\|^[\s\S]{1,256}$/`
`geo`	Array of longitude and latitude`/.+/i`
`lifetime`	lifetime duration (in days)`/^\+?(0\|[1-9]\d*)$/`
`desc`	details of classified/due/event/sponsor/room or empty string to reset it`/^$\|^[\s\S]{1,2000}$/`
`image_urls`	Array of image URLs`/^\[("(?:https?:\/\/)[\wa-z\u00a1-\uffff0-9\-_]+(\.[\wa-z\u00a1-\uffff0-9\-_]+)+([\wa-z\u00a1-\uffff0-9\-\.,;@?^=%&:\/~\+#!()\%][\wa-z\u00a1-\uffff0-9\-\@?^=%&\/~\+#!()\*%])?",?)+\]$/i`
`files`	Array of file structures`/[\s\S]*/`

Minsh apps API documentation v8

Preamble

Database

Tokens

Acquisition and validity of tokens

Endpoints

HTTP success/error codes

Rate limits

FAQ

How to login directly with a token on the web client?

How to obtain bigger profile images?

How to do a login in PHP?

How do you join groups automatically at signup?

API requests

POST

URL parameters

Required parameters

Optional parameters

Errors

URL parameters

Required parameters

Optional parameters

Errors

URL parameters

Required parameters

Optional parameters

Errors

URL parameters

Required parameters

Optional parameters

Errors

URL parameters

Required parameters

Optional parameters

Errors

URL parameters

Required parameters

Optional parameters

Errors

URL parameters

Required parameters

Optional parameters

Errors

URL parameters

Required parameters

Optional parameters

Errors

URL parameters

Required parameters

Optional parameters

Errors

URL parameters

Required parameters

Optional parameters

Errors

URL parameters

Required parameters

Optional parameters

Errors

URL parameters

Required parameters

Optional parameters

Errors

URL parameters

Required parameters

Optional parameters

Errors

URL parameters

Required parameters

Errors

URL parameters

Required parameters

Optional parameters

Errors

URL parameters

Required parameters

Optional parameters

Errors

URL parameters

Required parameters

How to login directly with a `token` on the web client?

`group_owner_token`	`/\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i`
`user`	Mongo ObjectId`/[0-9a-fA-F]{24}/i`

`token`	`/\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i`
`mute`	mute group boolean`/^(true)\|(false)$/i`

`owner`	owner flag`/^(true)\|(false)$/i`
`token`	`/\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i`

`read_only`	read-only flag`/^(true)\|(false)$/i`
`token`	`/\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i`

`username_or_email`	Username or email.`/^([a-z0-9_]{1,25})\|(^(?=.{1,64}@)(?:[0-9a-z](?:[-+.a-zA-Z0-9_]{0,62}[a-zA-Z0-9_])?\|\)@(?:[0-9a-z][-\w]\.)+[a-z]{2,63}$)$/i`
`password`	`/^.{3,50}$/`

`password_token`	Password token`/\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i`
`password`	`/^.{3,50}$/`

`notification_type`	type of the email notification`/^newsletter\|dm\|mention\|event\|event_reminder\|classified_reminder\|important$/`
`mailing_token`	Mailing token`/\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i`

`token`	`/\b([0-9a-f]{8}-?([0-9a-f]{4}-?){3}[0-9a-f]{12})\b/i`
`pin`	PIN is a string composed of 4 numbers`/^\d{4}$/`

`app`	App string between 1 and 25 characters`/[a-z0-9_-]{1,25}/`
`comment_id`	Mongo ObjectId`/[0-9a-fA-F]{24}/i`
`id`	Object id`/[0-9a-fA-F]{24}/`