Users

Users represent the people who have access to your organization on Feedier. On this page, we'll dive into the different user endpoints you can use to list, create, update, and delete users programmatically.

The user model

The user model contains all the information about a user, including their name, email, role, and team assignments.

Properties

Name
id
Type
integer
Description
Unique identifier for the user.
Name
name
Type
string
Description
The display name of the user.
Name
email
Type
string
Description
The email address of the user.
Name
role
Type
string
Description
The role assigned to the user. Possible values: admin editor viewer restricted_viewer.
Name
primary_team_id
Type
integer
Description
The unique identifier of the user's primary team.
Name
team_id
Type
integer
Description
The unique identifier of the team the user belongs to.
Name
created_at
Type
timestamp
Description
Timestamp of when the user was created.
Name
updated_at
Type
timestamp
Description
Timestamp of when the user was last updated.

GET/v3/users

List all users

This endpoint allows you to retrieve a paginated list of all users in your organization. By default, a maximum of fifteen users are shown per page.

Optional attributes

Name
per_page
Type
integer
Description
Number of items to display per page - 15 by default (max: 100).
Name
filter[name]
Type
string
Description
Filter users by name (partial match).
Name
filter[email]
Type
string
Description
Filter users by email (partial match).
Name
filter[role]
Type
string
Description
Filter users by role name (exact match).

Request

GET

/v3/users

curl -G https://api.bx.feedier.com/v3/users \
    -H "Authorization: Bearer {token}" \
    -d "filter[role]"=admin

Response

{
    "data": [
        {
            "id": 3,
            "name": "Aurelio Montoya",
            "email": "aurelio@example.com",
            "role": "admin",
            "primary_team_id": 4,
            "team_id": 4,
            "created_at": "2021-06-15T09:30:10+00:00",
            "updated_at": "2021-06-16T11:42:55+00:00"
        }
        // ...
    ],
    "links": {
        "first": "https://api.bx.feedier.com/v3/users?page=1",
        "last": "https://api.bx.feedier.com/v3/users?page=2",
        "prev": null,
        "next": "https://api.bx.feedier.com/v3/users?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "path": "https://api.bx.feedier.com/v3/users",
        "per_page": 15,
        "to": 15,
        "total": 25
    }
}

POST/v3/users

Create a user

This endpoint allows you to create a new user in your organization. A welcome email will be sent to the user unless the authentication method is OIDC.

Required attributes

Name
email
Type
string
Description
The email address of the user. Must be unique.
Name
role
Type
string
Description
The role to assign. Allowed values: admin editor viewer restricted_viewer.
Name
auth_method
Type
string
Description
The authentication method. Allowed values: password oidc.

Optional attributes

Name
name
Type
string
Description
The display name of the user. Defaults to the email address if not provided.
Name
team_id
Type
integer
Description
The primary team to assign the user to. Defaults to the root team of your organization.

Request

POST

/v3/users

curl https://api.bx.feedier.com/v3/users \
    -H "Authorization: Bearer {token}" \
    -d email="john@example.com" \
    -d name="John Doe" \
    -d role="viewer" \
    -d auth_method="password" \
    -d team_id=2

Response

{
    "id": 42,
    "name": "John Doe",
    "email": "john@example.com",
    "role": "viewer",
    "primary_team_id": 2,
    "team_id": 2,
    "created_at": "2025-03-12T10:00:00+00:00",
    "updated_at": "2025-03-12T10:00:00+00:00"
}

GET/v3/users/:id

Retrieve a user

This endpoint allows you to retrieve a user by providing their unique identifier.

Request

GET

/v3/users/42

curl https://api.bx.feedier.com/v3/users/42 \
    -H "Authorization: Bearer {token}"

Response

{
    "id": 42,
    "name": "John Doe",
    "email": "john@example.com",
    "role": "viewer",
    "primary_team_id": 2,
    "team_id": 2,
    "created_at": "2025-03-12T10:00:00+00:00",
    "updated_at": "2025-03-12T10:00:00+00:00"
}

PUT/v3/users/:id

Update a user

This endpoint allows you to update an existing user.

Optional attributes

Name
email
Type
string
Description
Update the user's email address. Must be unique.
Name
name
Type
string
Description
Update the user's display name.
Name
role
Type
string
Description
Update the user's role. Allowed values: admin editor viewer restricted_viewer.
Name
auth_method
Type
string
Description
Update the authentication method. Allowed values: password oidc.

Request

PUT

/v3/users/42

curl -X PUT https://api.bx.feedier.com/v3/users/42 \
    -H "Authorization: Bearer {token}" \
    -d name="John Updated" \
    -d role="editor"

Response

{
    "id": 42,
    "name": "John Updated",
    "email": "john@example.com",
    "role": "editor",
    "primary_team_id": 2,
    "team_id": 2,
    "created_at": "2025-03-12T10:00:00+00:00",
    "updated_at": "2025-03-12T12:30:00+00:00"
}

DELETE/v3/users/:id

Delete a user

This endpoint allows you to delete a user by their unique identifier.

Request

DELETE

/v3/users/42

curl -X DELETE https://api.bx.feedier.com/v3/users/42 \
    -H "Authorization: Bearer {token}"