API v1 Documentation

List all users

This version of the API docs is depreciated and will be taken offline soon.
Please migrate to the new version as soon as possible to avoid service disruption.

New version can be found at https://docs.wceaapi.org/

Returns all users of the authenticated organization.

Request

  • HTTP Verb: GET
  • URI: /user

Searchable Fields

email Example:

(email[lk]:test.org, name[eq]:Bob,
region[eq]:Illinois)

Find all users whose:

  • email contains test.org
  • Have the name Bob
  • And are from Illinois
name
surname
company
country
region
city
See Advanced queries for details on how to use Searchable Fields.

Request example

curl -H "Request-Time: Wed, 11 Dec 2013 13:15:04 +0000" \
     -H "Api-Key: 78b47a40f93378a6a487919edea6e92c" \
     -H "Signature: 0a035961fbf7d2ffdc5ca8780e0a33cb3d6c3a5f8fb0623e886c9933377d3e1e" \
     http://wceaapi.org/v1/user

Output Example

{
  "_meta": {
   ...
  },
  "records": [
    {
      "id": 1,
      "email": "adrian.perez@wcea.education",
      "name": "Adrián",
      "surname": "Pérez",
      "title": "Mr",
      "suffix": "PhD",
      "country": "Spain",
      "region": "Andalucía",
      "city": "Marbella",
      "company": "WCEA",
    },
    {
      "id": 2,
      "email": "tony.montana@wcea.education",
      "name": "Tony",
      "surname": "Montana",
      "title": "Dr",
      "suffix": "Scarface",
      "country": "United states of america",
      "region": "Illinois",
      "city": "Altona",
      "company": null,
    },
    ...
  ]
}