API Documentation

API Endpoint

Users

Users

GET /api/v2/users
Requestsreturns usersreturns :unauthorized

GET  /api/v2/users

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "131",
      "type": "users",
      "attributes": {
        "email": "user131@email.com",
        "first_name": "name",
        "last_name": "surname",
        "time_zone": null,
        "avatar_url": null,
        "default_organization_id": 67,
        "default_organization_slug": "67-organization67",
        "intercom_hash": "226382fe8e6203fbf9420915d2d5c98042a7a1edd5d0e3152ad20a79fd4f216e",
        "beta_features": [],
        "flags": {},
        "newsletter_consent": false,
        "newsletter_consent_at": null,
        "ical_token": null,
        "preferences": null,
        "sysadmin": false,
        "sysadmin_permissions": [],
        "two_factor_auth": false,
        "sso_provision": false,
        "account_access_expires_at": null,
        "locale": "en_US"
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/users?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/users?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200
  }
}

Gets users
GET/api/v2/users

GET /api/v2/users/1
Requestsreturns userreturns :not_found

GET  /api/v2/users/133

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "133",
    "type": "users",
    "attributes": {
      "email": "user133@email.com",
      "first_name": "name",
      "last_name": "surname",
      "time_zone": null,
      "avatar_url": null,
      "default_organization_id": 69,
      "default_organization_slug": "69-organization69",
      "intercom_hash": "d1a73734a7e6505278839dafa3337b7c31f37b23561c1d077ad5dbc8816d80a2",
      "beta_features": [],
      "flags": {},
      "newsletter_consent": false,
      "newsletter_consent_at": null,
      "ical_token": null,
      "preferences": null,
      "sysadmin": false,
      "sysadmin_permissions": [],
      "two_factor_auth": false,
      "sso_provision": false,
      "account_access_expires_at": null,
      "locale": "en_US"
    }
  },
  "meta": {}
}

Gets a user
GET/api/v2/users/{id}

URI Parameters
HideShow
id
number (required) Example: 1

user id

PATCH /api/v2/users/1
Requestsupdates userreturns error

PATCH  /api/v2/users/136

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "users",
    "attributes": {
      "default_organization_id": 2
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "136",
    "type": "users",
    "attributes": {
      "email": "user136@email.com",
      "first_name": "name",
      "last_name": "surname",
      "time_zone": null,
      "avatar_url": null,
      "default_organization_id": 71,
      "default_organization_slug": "71-organization71",
      "intercom_hash": "b1d4ae3015d206b975097f0f359491ad8b24c3e89dfea1e89f11dab9d8013edf",
      "beta_features": [],
      "flags": {},
      "newsletter_consent": false,
      "newsletter_consent_at": null,
      "ical_token": null,
      "preferences": null,
      "sysadmin": false,
      "sysadmin_permissions": [],
      "two_factor_auth": false,
      "sso_provision": false,
      "account_access_expires_at": null,
      "locale": "en_US"
    }
  },
  "meta": {}
}

Update a user
PATCH/api/v2/users/{id}

URI Parameters
HideShow
id
number (required) Example: 1

user id

PATCH /api/v2/users/1/update_password
Requestsupdates password

PATCH  /api/v2/users/138/update_password

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "users",
    "attributes": {
      "current_password": "password1234",
      "password": "newpassword1234"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "138",
    "type": "users",
    "attributes": {
      "email": "user138@email.com",
      "first_name": "name",
      "last_name": "surname",
      "time_zone": null,
      "avatar_url": null,
      "default_organization_id": 73,
      "default_organization_slug": "73-organization73",
      "intercom_hash": "084dab91c6ca564b8f568b564c86dd61983d010565b1d22831c4e30216467421",
      "beta_features": [],
      "flags": {},
      "newsletter_consent": false,
      "newsletter_consent_at": null,
      "ical_token": null,
      "preferences": null,
      "sysadmin": false,
      "sysadmin_permissions": [],
      "two_factor_auth": false,
      "sso_provision": false,
      "account_access_expires_at": null,
      "locale": "en_US"
    }
  },
  "meta": {}
}

Update password for a user
PATCH/api/v2/users/{id}/update_password

URI Parameters
HideShow
id
number (required) Example: 1

user id

Generated by aglio on 31 May 2025