Users

Endpointhttps://api.idol.io/api/v2

User account management and authentication.

Use /users/me to retrieve the currently authenticated user's details.

List users

GET

https://api.idol.io/api/v2

/users

Retrieve a paginated list of users. Returns users within the managed groups of the authenticated user.

List users › query Parameters

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

include

string

Comma-separated list of related resources to include

filter[group-id]

string

Filter by group ID

filter[active]

boolean

Filter by active status

List users › Responses

Successful response

object[]

object

object[]

Create a user

POST

https://api.idol.io/api/v2

/users

Create a new user. The user will be assigned to a group and an invitation email will be sent automatically, unless skip-invitation is set to true.

Create a user › Request Body

object · required

Create a user › Responses

User created successfully

object

object[]

POST/users

curl --request POST \
  --url https://api.idol.io/api/v2/users \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "users",
    "attributes": {
      "login": "login",
      "email": "test@example.com",
      "name": "name",
      "first-name": "first-name",
      "password": "password",
      "password-confirmation": "password-confirmation",
      "skip-invitation": true
    },
    "relationships": {
      "group": {
        "data": {
          "type": "groups",
          "id": "id"
        }
      },
      "language": {
        "data": {
          "type": "languages",
          "id": "id"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "users",
    "attributes": {
      "login": "login",
      "email": "test@example.com",
      "name": "name",
      "first-name": "first-name",
      "password": "password",
      "password-confirmation": "password-confirmation",
      "skip-invitation": true
    },
    "relationships": {
      "group": {
        "data": {
          "type": "groups",
          "id": "id"
        }
      },
      "language": {
        "data": {
          "type": "languages",
          "id": "id"
        }
      }
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Get a user

GET

https://api.idol.io/api/v2

/users/{id}

Retrieve a single user by ID. Use me as the ID to retrieve the currently authenticated user.

Get a user › path Parameters

id

string · required

Resource ID

Get a user › query Parameters

include

string

Comma-separated list of related resources to include

Get a user › Responses

Successful response

object

object[]

Update a user

PATCH

https://api.idol.io/api/v2

/users/{id}

Update a user's attributes. login and email cannot be changed. Password changes are only allowed when updating one's own account.

Update a user › path Parameters

id

string · required

Resource ID

Update a user › Request Body

object · required

Update a user › Responses

User updated successfully

object

object[]

PATCH/users/{id}

curl --request PATCH \
  --url https://api.idol.io/api/v2/users/:id \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "users",
    "id": "id",
    "attributes": {
      "name": "name",
      "first-name": "first-name",
      "active": true,
      "password": "password",
      "password-confirmation": "password-confirmation"
    },
    "relationships": {
      "language": {
        "data": {
          "type": "languages",
          "id": "id"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "users",
    "id": "id",
    "attributes": {
      "name": "name",
      "first-name": "first-name",
      "active": true,
      "password": "password",
      "password-confirmation": "password-confirmation"
    },
    "relationships": {
      "language": {
        "data": {
          "type": "languages",
          "id": "id"
        }
      }
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Invite a user

PUT

https://api.idol.io/api/v2

/users/{id}/invite

Activate a user and send them an invitation email.

Invite a user › path Parameters

id

string · required

Resource ID

Invite a user › Responses

Invitation sent successfully

object

object[]

Get current user

GET

https://api.idol.io/api/v2

/users/me

Retrieve the currently authenticated user's details.

Get current user › query Parameters

include

string

Comma-separated list of related resources to include

Get current user › Responses

Successful response

object

object[]

Extracts Groups

Labelcamp API v2

Users

Endpointhttps://api.idol.io/api/v2

User account management and authentication.

Use /users/me to retrieve the currently authenticated user's details.

List users

GET

https://api.idol.io/api/v2

/users

Retrieve a paginated list of users. Returns users within the managed groups of the authenticated user.

List users › query Parameters

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

include

string

Comma-separated list of related resources to include

filter[group-id]

string

Filter by group ID

filter[active]

boolean

Filter by active status

List users › Responses

Successful response

object[]

object

object[]

Create a user

POST

https://api.idol.io/api/v2

/users

Create a new user. The user will be assigned to a group and an invitation email will be sent automatically, unless skip-invitation is set to true.

Create a user › Request Body

object · required

Create a user › Responses

User created successfully

object

object[]

POST/users

curl --request POST \
  --url https://api.idol.io/api/v2/users \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "users",
    "attributes": {
      "login": "login",
      "email": "test@example.com",
      "name": "name",
      "first-name": "first-name",
      "password": "password",
      "password-confirmation": "password-confirmation",
      "skip-invitation": true
    },
    "relationships": {
      "group": {
        "data": {
          "type": "groups",
          "id": "id"
        }
      },
      "language": {
        "data": {
          "type": "languages",
          "id": "id"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "users",
    "attributes": {
      "login": "login",
      "email": "test@example.com",
      "name": "name",
      "first-name": "first-name",
      "password": "password",
      "password-confirmation": "password-confirmation",
      "skip-invitation": true
    },
    "relationships": {
      "group": {
        "data": {
          "type": "groups",
          "id": "id"
        }
      },
      "language": {
        "data": {
          "type": "languages",
          "id": "id"
        }
      }
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Get a user

GET

https://api.idol.io/api/v2

/users/{id}

Retrieve a single user by ID. Use me as the ID to retrieve the currently authenticated user.

Get a user › path Parameters

id

string · required

Resource ID

Get a user › query Parameters

include

string

Comma-separated list of related resources to include

Get a user › Responses

Successful response

object

object[]

Update a user

PATCH

https://api.idol.io/api/v2

/users/{id}

Update a user's attributes. login and email cannot be changed. Password changes are only allowed when updating one's own account.

Update a user › path Parameters

id

string · required

Resource ID

Update a user › Request Body

object · required

Update a user › Responses

User updated successfully

object

object[]

PATCH/users/{id}

curl --request PATCH \
  --url https://api.idol.io/api/v2/users/:id \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "users",
    "id": "id",
    "attributes": {
      "name": "name",
      "first-name": "first-name",
      "active": true,
      "password": "password",
      "password-confirmation": "password-confirmation"
    },
    "relationships": {
      "language": {
        "data": {
          "type": "languages",
          "id": "id"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "users",
    "id": "id",
    "attributes": {
      "name": "name",
      "first-name": "first-name",
      "active": true,
      "password": "password",
      "password-confirmation": "password-confirmation"
    },
    "relationships": {
      "language": {
        "data": {
          "type": "languages",
          "id": "id"
        }
      }
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Invite a user

PUT

https://api.idol.io/api/v2

/users/{id}/invite

Activate a user and send them an invitation email.

Invite a user › path Parameters

id

string · required

Resource ID

Invite a user › Responses

Invitation sent successfully

object

object[]

Get current user

GET

https://api.idol.io/api/v2

/users/me

Retrieve the currently authenticated user's details.

Get current user › query Parameters

include

string

Comma-separated list of related resources to include

Get current user › Responses

Successful response

object

object[]

Extracts Groups