Users

LIVE

https://app.polarix.io

GET

/api/{version}/users

Using the endpoint alone with no optional parameters will retrieve users assigned only to the Polarix.io customer in which the request is made.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

version

number

required

Target Polarix.io API version

Example:

Header Params

x-api-key

string

required

API Key generated from the Settings panel in Polarix.io

Example:

b062ab000e9456748b941cd5b1658899

string

optional

application/json or application/xml

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'https://app.polarix.io/api/1.0/users' \
--header 'x-api-key: b062ab000e9456748b941cd5b1658899' \
--header 'Accept: application/json'

Responses

🟢200Success — JSON

application/json

Body

array of:

name

string

required

name

string

required

avatar

string

optional

avatar

Example

[
    {
        "name": "John Doe",
        "email": "john.doe@gmail.com",
        "avatar": "https://lhg-digital.s3.us-east-1.amazonaws.com/polarixv2/users/JohnDoe.jpeg"
    },
    {
        "name": "Jane Doe",
        "email": "jane.doe@gmail.com",
        "avatar": "https://lhg-digital.s3.us-east-1.amazonaws.com/polarixv2/users/JaneDoe.jpeg"
    }
]

🟢200Success — XML

🟠401Unauthorized — JSON

🟠401Unauthorized — XML

🔴500Server Error — JSON

🔴500Server Error — XML

Authentication

Project List