User

This API endpoint is only available to group owners. The assignable roles can be obtained using the Role API.

List all users

Get the list of all users that belong to the current user's group.

API Request

GET https://api.bespokify.com/v2/users

Request parameters

Parameters Type Required Description
search string no The text used to search users' emails, first names and last names
orderBy string no The field to order users by. Possible values: createdAt, lastName, firstName. Default: createdAt
sort string no The order to sort users in. Possible values: asc, desc. Default: desc

Example request

GET https://api.bespokify.com/v2/users?search=foo&orderBy=firstName&sort=asc

Example response

[
  {
    "id": "2966a992-34ce-432c-9c76-bd1684866a8c",
    "email": "foo@bar.com",
    "firstName": "Jane",
    "lastName": "Doe",
    "createdAt": "2019-03-05T03:19:27.399Z",
    "isAdmin": true,
    "enabled": true
  },
  {
    "id": "43949d72-524a-4435-8b8a-7eae341a31fe",
    "email": "bar@foo.com",
    "firstName": "John",
    "lastName": "Smith",
    "createdAt": "2018-10-17T09:52:05.399Z",
    "isAdmin": false,
    "enabled": true
  }
]

Get a single user

Get a user by ID.

API Request

GET https://api.bespokify.com/v2/users/{id}

Request parameters

Parameter Type Required Description
id string yes The user's ID

Example response

{
  "id": "43949d72-524a-4435-8b8a-7eae341a31fe",
  "email": "foo@bar.com",
  "firstName": "John",
  "lastName": "Smith",
  "enabled": true,
  "roles": ["drafts"],
  "createdAt": "2018-10-17T09:52:05.399Z"
}

Create user

API Request

POST https://api.bespokify.com/v2/users

Request parameters

Parameter Type Required Description
email string yes The user's email
firstName string yes The user's first name
lastName string yes The user's last name
enabled boolean no Whether the user will be enabled or not. Default: true
roles array no The roles to assign to the user

Example request

{
  "email": "foo@bar.com",
  "firstName": "John",
  "lastName": "Smith",
  "enabled": true,
  "roles": ["drafts"]
}

Example response

{
  "id": "43949d72-524a-4435-8b8a-7eae341a31fe",
  "email": "foo@bar.com",
  "firstName": "John",
  "lastName": "Smith",
  "createdAt": "2018-10-17T09:52:05.399Z",
  "enabled": true,
  "roles": ["drafts"]
}

Update user

API Request

PATCH https://api.bespokify.com/v2/users/{id}

Request parameters

Parameter Type Required Description
email string no The user's new email address
firstName string no The user's new first name
lastName string no The user's new last name
enabled boolean no Whether the user will be enabled or not
roles array no The new roles to assign to the user

Example request

{
  "email": "bar@foo.com",
  "firstName": "John",
  "lastName": "Smith",
  "enabled": false,
  "roles": ["exports"]
}

Example response

{
  "id": "43949d72-524a-4435-8b8a-7eae341a31fe",
  "email": "bar@foo.com",
  "firstName": "John",
  "lastName": "Smith",
  "createdAt": "2018-10-17T09:52:05.399Z",
  "enabled": false,
  "roles": ["exports"]
}

Delete user

API Request

DELETE https://api.bespokify.com/v2/users/{id}

Request parameters

Parameter Type Required Description
id string yes The ID of the user to delete

Response status codes

Code Meaning
204 No Content The user was deleted successfully
404 Not Found A user with the provided ID could not be found

Option types

Getting Started
Endpoints
Other Concepts