GET /open_api/v1/users
Users index

Users index, paginated. Ordered by created_at descendant.

Supported Formats

json

Examples

# /open_api/v1/users?page=1&per_page=4
{
  "users": [
    {
      "id": 1746,
      "email": "xxxxxxx@xxxx.com",
      "created_at": "2016-05-04T17:21:48.403+02:00",
      "invoicing_profile_id": 7824,
      "external_id": "J5821-4"
      "full_name": "xxxx xxxx",
      "first_name": "xxxx",
      "last_name": "xxxx",
      "gender": "man",
      "organization": true,
      "address": "2 impasse xxxxxx, BRUXELLES",
      "group": {
        "id": 1,
        "name": "standard, association",
        "slug": "standard"
      }
    },
    {
      "id": 1745,
      "email": "xxxxxxx@gmail.com",
      "created_at": "2016-05-03T15:21:13.125+02:00",
      "invoicing_profile_id": 7823,
      "external_id": "J5846-4"
      "full_name": "xxxxx xxxxx",
      "first_name": "xxxxx",
      "last_name": "xxxxx",
      "gender": "woman",
      "organization": true,
      "address": "Grenoble",
      "group": {
        "id": 2,
        "name": "étudiant, - de 25 ans, enseignant, demandeur d'emploi",
        "slug": "student"
      }
    },
    {
      "id": 1744,
      "email": "xxxxxxx@gmail.com",
      "created_at": "2016-05-03T13:51:03.223+02:00",
      "invoicing_profile_id": 7822,
      "external_id": "J5900-1"
      "full_name": "xxxxxxx xxxx",
      "first_name": "xxxxxxx",
      "last_name": "xxxx",
      "gender": "man",
      "organization": false,
      "address": "21 rue des xxxxxx",
      "group": {
        "id": 1,
        "name": "standard, association",
        "slug": "standard"
      }
    },
    {
      "id": 1743,
      "email": "xxxxxxxx@setecastronomy.eu",
      "created_at": "2016-05-03T12:24:38.724+02:00",
      "invoicing_profile_id": 7821,
      "external_id": "P4172-4"
      "full_name": "xxx xxxxxxx",
      "first_name": "xxx",
      "last_name": "xxxxxxx",
      "gender": "woman",
      "organization": false,
      "address": "147 rue xxxxxx, 75000 PARIS, France",
      "group": {
        "id": 1,
        "name": "standard, association",
        "slug": "standard"
      }
    }
  ]
}

# /open_api/v1/users?user_id[]=1746&user_id[]=1745
{
  "users": [
    {
      "id": 1746,
      "email": "xxxxxxxxxxxx",
      "created_at": "2016-05-04T17:21:48.403+02:00",
      "invoicing_profile_id": 7820,
      "external_id": "J5500-4"
      "full_name": "xxxx xxxxxx",
      "first_name": "xxxx",
      "last_name": "xxxxxx",
      "gender": "man",
      "organization": true,
      "address": "38100",
      "group": {
        "id": 1,
        "name": "standard, association",
        "slug": "standard"
      }
    },
    {
      "id": 1745,
      "email": "xxxxxxxxx@gmail.com",
      "created_at": "2016-05-03T15:21:13.125+02:00",
      "invoicing_profile_id": 7819,
      "external_id": null,
      "full_name": "xxxxx xxxxxx",
      "first_name": "xxxx",
      "last_name": "xxxxxx",
      "gender": "woman",
      "organization": true,
      "address": "",
      "group": {
        "id": 2,
        "name": "étudiant, - de 25 ans, enseignant, demandeur d'emploi",
        "slug": "student"
      }
    }
  ]
}

Params

Param name	Description
page optional	Page number Validations: Must be a Integer
per_page optional	Number of objects per page. Default is 20. Validations: Must be a Integer
email optional	Filter users by email using strict matching. Validations: Must be one of: String, Array.
user_id optional	Filter users by id using strict matching. Validations: Must be one of: Integer, Array.
created_after optional	Filter users to accounts created after the given date. Validations: Must be a DateTime
including_deleted_users optional	Filter users to accounts deleted or not. Validations: Must be one of: true, false.