Skip to main content

Users API

The Users API allows you to manage user accounts and retrieve user information.

List Users​

Get a list of users.

Endpoint: GET /users

Headers:

  • X-F-Authorization: Client token (required)

Query Parameters:

  • limit (optional): Number of results to return
  • offset (optional): Number of results to skip
  • role (optional): Filter by role ID(s) (comma-separated)

Response:

[
  {
    "id": "user-id",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com",
    "photo": "https://example.com/photo.jpg",
    "roles": [
      {
        "id": "role-id"
      }
    ]
  }
]

Get Current User​

Get the currently authenticated user's information.

Endpoint: GET /users/me

Headers:

  • X-F-Authorization: Client token (required)
  • X-F-Authentication: User token (required)

Response:

{
  "id": "user-id",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john@example.com",
  "photo": "https://example.com/photo.jpg",
  "roles": [
    {
      "id": "role-id"
    }
  ]
}

Get User​

Get details of a specific user.

Endpoint: GET /users/:id

Headers:

  • X-F-Authorization: Client token (required)

Response:

{
  "id": "user-id",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john@example.com",
  "photo": "https://example.com/photo.jpg",
  "roles": [
    {
      "id": "role-id"
    }
  ]
}

Create User​

Create a new user account.

Endpoint: POST /users

Headers:

  • X-F-Authorization: Client token (required)
  • X-F-Authentication: User token (required)

Request Body:

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john@example.com",
  "password": "secure-password",
  "photo": "base64-encoded-image-or-url"
}

Response: Returns the created user object (password is not included).

Update User​

Update an existing user.

Endpoint: PUT /users/:id

Headers:

  • X-F-Authorization: Client token (required)
  • X-F-Authentication: User token (required)

Request Body:

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john@example.com",
  "photo": "base64-encoded-image-or-url"
}

Delete User​

Delete a user account.

Endpoint: DELETE /users/:id

Headers:

  • X-F-Authorization: Client token (required)
  • X-F-Authentication: User token (required)