Welcome
What's new
Data privacy & Security
Guides
Quickstart
Deep dives
References
Resources
Design & Structure
Data
Components
Collaboration
Project Settings
Jet Admin API
Users API
Teams API
DEPLOYMENT
Cloud
Self-hosted
On-premise
Database Heroku deployment
Powered by GitBook

Users API

get
Get list of all project users

https://api.jetadmin.io/api/projects/:PROJECT_NAME/users/
Request
Response
Request
Path Parameters
PROJECT_NAME
required
string
Unique project name (can be taken from Jet Admin project URL)
Headers
Authorization
required
string
Token authentication, example: Authorization: ProjectToken f42a3cab3f146b283701a4e314f1c7ba57fdb59e
Response
200: OK
{
    id: 1504,
    user: {
        username: "a.svetlov@geex-arts.com"
        first_name: "Anton"
        last_name: "Svetlov"
        email: "a.svetlov@geex-arts.com"
        photo: "https://api.jetadmin.io/media/user/photo/2018/10/09/18402150_1144874585658871_7416256167591393723_o.jpg"
        uid: "28c9bc6d-1f80-4898-93d3-154fa66b22ac"
    },
    user_email: null
    group: {
        id: 1491
        name: "Administrators"
        description: ""
        super_group: true
        project_permissions: []
        properties: {}
    },
    properties: {
        office: "Dubai"
    },
    date_add: "2018-09-30T16:58:52.067471+03:00"
}

post
Invite new project user and send invite

https://api.jetadmin.io/api/projects/:PROJECT_NAME/users/
Request
Response
Request
Path Parameters
PROJECT_NAME
required
string
Unique project name (can be taken from Jet Admin project URL)
Headers
Authorization
required
string
Token authentication, example: Authorization: ProjectToken f42a3cab3f146b283701a4e314f1c7ba57fdb59e
Body Parameters
user_email
required
string
User email, example: a.svetlov@geex-arts.com
group
required
number
Group ID, example: 1491
properties
optional
object
JSON Object, example: {office: "New York"}
Response
201: Created
{
    id: 1504,
    user_email: null
    group: 1491,
    properties: {
        office: "Dubai"
    },
    date_add: "2018-09-30T16:58:52.067471+03:00"
}

patch
Update existing project user

https://api.jetadmin.io/api/projects/:PROJECT_NAME/users/:USER_ID/
Request
Response
Request
Path Parameters
PROJECT_NAME
required
string
Unique project name (can be taken from Jet Admin project URL)
USER_ID
required
number
Project user ID
Headers
Authorization
required
string
Token authentication, example: Authorization: ProjectToken f42a3cab3f146b283701a4e314f1c7ba57fdb59e
Body Parameters
user_email
optional
string
User email, example: a.svetlov@geex-arts.com
group
optional
number
Group ID, example: 1491
properties
optional
object
JSON Object, example: {office: "New York"}
Response
200: OK
{
    id: 1504,
    user_email: null
    group: 1491,
    properties: {
        office: "Dubai"
    },
    date_add: "2018-09-30T16:58:52.067471+03:00"
}

delete
Delete existing project user

https://api.jetadmin.io/api/projects/:PROJECT_NAME/users/:USER_ID/
Request
Response
Request
Path Parameters
PROJECT_NAME
required
string
Unique project name (can be taken from Jet Admin project URL)
USER_ID
required
number
Project user ID
Headers
Authorization
required
string
Token authentication, example: Authorization: ProjectToken f42a3cab3f146b283701a4e314f1c7ba57fdb59e
Response
204: No Content
​
References - Previous
Jet Admin API
Next
Teams API
Last updated 7 months ago
Contents
get
Get list of all project users
post
Invite new project user and send invite
patch
Update existing project user
delete
Delete existing project user