List Users | Polytomic Docs

curl https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>"

{
  "data": [
    {
      "email": "jane.doe@polytomic.com",
      "id": "a3f1c9e2-4b7d-4f8a-9c2e-1d2f3b4a5c6d",
      "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "role_ids": [
        "d9f8e7c6-b5a4-4321-9f8e-7d6c5b4a3e2f"
      ],
      "role": "admin"
    },
    {
      "email": "john.smith@polytomic.com",
      "id": "b7e2d3c4-5f6a-4b8c-9d0e-1f2a3b4c5d6e",
      "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "role_ids": [
        "e1f2d3c4-b5a6-4789-9a0b-1c2d3e4f5a6b"
      ],
      "role": "user"
    }
  ]
}

Lists all users in the specified organization.

🚧 Requires partner key

User endpoints are only accessible using partner keys.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

AuthorizationBearer

This is the Polytomic API key

Path parameters

org_idstringRequiredformat: "uuid"

Unique identifier of the organization whose users should be listed.

Response

datalist of objects or null

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

Authentication

Path parameters

Headers

Response

Errors