Users | flxbl docs

flxbl docs

slack GitHub

List users in a team

get

Authorizations

Query parameters

teamstringOptional

Team identifier (slug) to filter users by

Example: engineering

limitnumberOptional

Number of records to return

Example: 10

offsetnumberOptional

Number of records to skip

Example: 0

rolestring · enumOptional

Filter by role

Possible values:

Responses

200

List of users retrieved successfully

application/json

400

Bad request

401

Unauthorized

get

GET /sfp/api/users HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "users": [
    {
      "id": "text",
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "role": "owner",
      "teams": [
        "text"
      ],
      "authData": {}
    }
  ],
  "total": 1
}

Get current user profile

get

Authorizations

Responses

200

User profile retrieved successfully

application/json

401

Unauthorized

get

GET /sfp/api/users/me HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "id": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "role": "owner",
  "teams": [
    "text"
  ],
  "authData": {}
}

Get user by email

get

Authorizations

Path parameters

emailstringRequired

User email

Query parameters

teamstringOptional

Team slug (optional for self-lookups)

Responses

200

User profile retrieved successfully

application/json

400

Bad request

401

Unauthorized

404

User not found

get

GET /sfp/api/users/{email} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "id": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "role": "owner",
  "teams": [
    "text"
  ],
  "authData": {}
}

Update user details

put

Authorizations

Path parameters

emailstringRequired

User email

Query parameters

teamstringOptional

Team slug (optional)

Body

firstNamestringOptional

First name of the user

Example: John

lastNamestringOptional

Last name of the user

Example: Doe

rolestring · enumOptional

Role of the user in the team

Possible values:

Responses

200

User updated successfully

application/json

400

Bad request

401

Unauthorized

404

User not found

put

PUT /sfp/api/users/{email} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "firstName": "John",
  "lastName": "Doe",
  "role": "owner"
}

{
  "success": true,
  "user": {
    "id": "text",
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "role": "owner",
    "teams": [
      "text"
    ],
    "authData": {}
  },
  "error": "text"
}

Delete a user from a team

delete

Authorizations

Body

emailstringRequired

Email address of the user to remove

Example: john.doe@example.com

teamstringOptional

Team identifier (slug) to remove the user from. If not provided, user will be removed from all teams.

Example: engineering

Responses

200

User deleted successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

delete

DELETE /sfp/api/users HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "email": "john.doe@example.com",
  "team": "engineering"
}

{
  "success": true,
  "email": "text",
  "team": "text",
  "userId": "text",
  "teamAccountId": "text",
  "error": "text"
}

Create a new user in a team

post

Authorizations

Body

firstNamestringRequired

First name of the user

Example: John

lastNamestringRequired

Last name of the user

Example: Doe

emailstringRequired

Email address of the user

Example: john.doe@example.com

teamstringRequired

Team identifier (slug) to add the user to

Example: engineering

rolestring · enumRequired

Role of the user in the team

Default: memberPossible values:

Responses

201

User created successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

post

POST /sfp/api/users HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "team": "engineering",
  "role": "member"
}

{
  "success": true,
  "userId": "text",
  "teamAccountId": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "team": "text",
  "role": "owner",
  "isExistingUser": true,
  "error": "text"
}