---
title: "Users"
url: "https://earlyaccess.developers.bynder.com/apis/users-1/versions/81ec58a1-c748-4616-b383-861ec1c98a2d"
---

# Users

OpenAPI specification document.

```json
{"components":{"schemas":{"User":{"properties":{"active":{"default":1,"enum":[1,0],"type":"integer"},"companyName":{"type":"string"},"costCenter":{"type":"string"},"department":{"type":"string"},"email":{"type":"string"},"firstname":{"type":"string"},"groupIds":{"type":"string"},"infix":{"type":"string"},"isSSOOnly":{"default":false,"type":"boolean"},"job":{"type":"string"},"language":{"type":"string"},"lastname":{"type":"string"},"password":{"type":"string"},"phoneNumber":{"type":"string"},"profileId":{"type":"string"},"username":{"type":"string"}},"required":["password","email","profileId","firstname","lastname"]}},"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"USERMANAGEMENT":"Grants permission to manage users"},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"USERMANAGEMENT":"Grants permission to manage users"},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Users","version":"1.0.0"},"openapi":"3.1.0","paths":{"/api/v4/currentUser/":{"get":{"description":"Retrieve the current user information. Unlike [Retrieve specific user](#reference/users/specific-user-operations/retrieve-specific-user) this call doesn't require you to know your user id in order to retrieve your current user information.\n","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"active":{"type":"boolean"},"address":{"type":"string"},"cellphoneNumber":{"type":"string"},"city":{"type":"string"},"companyName":{"type":"string"},"costCenter":{"type":"string"},"country":{"type":"string"},"county":{"type":"string"},"department":{"type":"string"},"departmentCode":{"type":"string"},"email":{"type":"string"},"employeeNumber":{"type":"string"},"firstname":{"type":"string"},"gender":{"type":"string"},"id":{"type":"string"},"infix":{"type":"string"},"isSSOOnly":{"type":"boolean"},"job":{"type":"string"},"language":{"type":"string"},"lastLogin":{"format":"date-time","type":"string"},"lastname":{"type":"string"},"legalEntity":{"type":"string"},"persisted":{"type":"boolean"},"phoneNumber":{"type":"string"},"postalCode":{"type":"string"},"profileId":{"type":"string"},"state":{"type":"string"},"terms":{"type":"string"},"timeZone":{"type":"string"},"username":{"type":"string"}},"type":"object"}}},"description":"Successful response"}},"summary":"Retrieve current user","tags":["Current User"]}},"/api/v4/users/":{"get":{"parameters":[{"description":"Whether to include inactive users in the list of results.","in":"query","name":"includeInActive","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Maximum results to return. If limit is not provided, all results are returned.","in":"query","name":"limit","required":false,"schema":{"default":100,"type":"integer"}},{"description":"What page of results to return.","in":"query","name":"page","required":false,"schema":{"default":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"properties":{"active":{"type":"integer"},"country":{"type":"string"},"email":{"type":"string"},"email2":{"type":"string"},"employeeNumber":{"type":"string"},"groups":{"items":{"properties":{"id":{"type":"string"},"name":{"type":"string"}},"type":"object"},"type":"array"},"id":{"type":"string"},"isSSOOnly":{"type":"boolean"},"name":{"type":"string"},"profileId":{"type":"string"},"salesrepId":{"type":"string"},"timeZone":{"type":"string"},"username":{"type":"string"},"website":{"type":"string"}},"type":"object"},"type":"array"}}},"description":"Successful response","headers":{"X-Pagination-Limit":{"description":"Limit of records per page.","schema":{"type":"integer"}},"X-Pagination-Page":{"description":"Current page number.","schema":{"type":"integer"}},"X-Pagination-TotalPages":{"description":"Total number of pages.","schema":{"type":"integer"}},"X-Pagination-TotalRecords":{"description":"Total number of records.","schema":{"type":"integer"}}}}},"security":[{"permanentToken":["USERMANAGEMENT"]},{"OAuth2":["USERMANAGEMENT"]}],"summary":"Retrieve users","tags":["Users"]},"post":{"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/User"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string"},"username":{"type":"string"}},"type":"object"}}},"description":"User created"}},"security":[{"permanentToken":["USERMANAGEMENT"]},{"OAuth2":["USERMANAGEMENT"]}],"summary":"Create user","tags":["Users"]}},"/api/v4/users/{id}":{"delete":{"parameters":[{"description":"The id or username of the user you’d like to delete.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"User deleted"}},"security":[{"permanentToken":["USERMANAGEMENT"]},{"OAuth2":["USERMANAGEMENT"]}],"summary":"Delete user","tags":["Users ID"]},"get":{"parameters":[{"description":"The id or username of the user you’d like to retrieve.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"active":{"type":"boolean"},"address":{"type":"string"},"cellphoneNumber":{"type":"string"},"city":{"type":"string"},"companyName":{"type":"string"},"costCenter":{"type":"string"},"country":{"type":"string"},"county":{"type":"string"},"department":{"type":"string"},"departmentCode":{"type":"string"},"email":{"type":"string"},"employeeNumber":{"type":"string"},"firstname":{"type":"string"},"gender":{"type":"string"},"groups":{"items":{"properties":{"id":{"type":"string"},"name":{"type":"string"}},"type":"object"},"type":"array"},"id":{"type":"string"},"infix":{"type":"string"},"isSSOOnly":{"type":"boolean"},"job":{"type":"string"},"language":{"type":"string"},"lastLogin":{"format":"date-time","type":"string"},"lastname":{"type":"string"},"legalEntity":{"type":"string"},"persisted":{"type":"boolean"},"phoneNumber":{"type":"string"},"postalCode":{"type":"string"},"profileId":{"type":"string"},"state":{"type":"string"},"terms":{"type":"string"},"timeZone":{"type":"string"},"username":{"type":"string"}},"type":"object"}}},"description":"Successful response"}},"security":[{"permanentToken":["USERMANAGEMENT"]},{"OAuth2":["USERMANAGEMENT"]}],"summary":"Retrieve specific user","tags":["Users ID"]},"post":{"parameters":[{"description":"The id of the user you’d like to modify.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"active":{"default":1,"enum":[1,0],"type":"integer"},"companyName":{"type":"string"},"costCenter":{"type":"string"},"department":{"type":"string"},"email":{"type":"string"},"firstname":{"type":"string"},"groupIds":{"type":"string"},"infix":{"type":"string"},"isSSOOnly":{"default":false,"type":"boolean"},"job":{"type":"string"},"language":{"type":"string"},"lastname":{"type":"string"},"password":{"type":"string"},"phoneNumber":{"type":"string"},"profileId":{"type":"string"},"termsAccepted":{"type":"boolean"},"username":{"type":"string"}},"type":"object"}}}},"responses":{"202":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string"},"username":{"type":"string"}},"type":"object"}}},"description":"User modified"}},"security":[{"permanentToken":["USERMANAGEMENT"]},{"OAuth2":["USERMANAGEMENT"]}],"summary":"Modify user","tags":["Users ID"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Manage users within your Bynder account. You can create, retrieve, update, and delete users as needed.\n","name":"Users"},{"description":"Manage specific users by their ID. This includes retrieving, updating, and deleting user information based on the user ID.\n","name":"Users ID"},{"description":"Retrieve information about the currently authenticated user without needing to know their user ID.         \n","name":"Current User"}]}
```