Reelyze Developer API

Users

Endpoint:https://developer-api.reelyze.com

Manage users within your Reelyze tenant

Query Users

GET

https://developer-api.reelyze.com

/v2/users

Retrieves a list of users, filtered based on optional querystring parameters. Parameters shown are examples, but any user property can be supplied as a query filter.

Query Users › query Parameters

emailstring
Filter by email address
phoneNumberstring
Filter by phone number (international format, e.g. +447777123456)

Query Users › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Users › Responses

idstring · required
firstNamestring · required
lastNamestring · required
displayNamestring · required
rolestring · enum · required
Enum values:
user
creator
manager
admin

organisationIdstring
invitationStatusstring · enum
Enum values:
accepted
none
pending
requested
avatarUrlstring
emailstring
phoneNumberstring
jobRolestring
departmentIdstring
isOnboardingCompleteboolean
sourcestring · enum
Enum values:
manual
integration
organisationNamestring
departmentNamestring
lastActiveobject

Create User

POST

https://developer-api.reelyze.com

/v2/users

Creates a new user. Users must have at least one identity property (email / phoneNumber) specified.

Create User › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Create User › Request Body

Create User › Responses

Created

idstring · required
firstNamestring · required
lastNamestring · required
displayNamestring · required
rolestring · enum · required
Enum values:
user
creator
manager
admin

organisationIdstring
invitationStatusstring · enum
Enum values:
none
requested
pending
accepted
avatarUrlstring
emailstring
phoneNumberstring
jobRolestring
departmentIdstring

Get User

GET

https://developer-api.reelyze.com

/v2/users/{id}

Retrieves details for a user

Get User › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get User › Responses

idstring · required
firstNamestring · required
lastNamestring · required
displayNamestring · required
rolestring · enum · required
Enum values:
user
creator
manager
admin

organisationIdstring
invitationStatusstring · enum
Enum values:
none
requested
pending
accepted
avatarUrlstring
emailstring
phoneNumberstring
jobRolestring
departmentIdstring

Delete User

DELETE

https://developer-api.reelyze.com

/v2/users/{id}

Deletes the specified user

Delete User › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Delete User › Responses

No Content

No data returned

Update User

PATCH

https://developer-api.reelyze.com

/v2/users/{id}

Update details for the specified user

Update User › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update User › Request Body

Update User › Responses

Updated user state

idstring · required
firstNamestring · required
lastNamestring · required
displayNamestring · required
rolestring · enum · required
Enum values:
user
creator
manager
admin

organisationIdstring
invitationStatusstring · enum
Enum values:
none
requested
pending
accepted
avatarUrlstring
emailstring
phoneNumberstring
jobRolestring
departmentIdstring

Organisations

Query Users

GET

https://developer-api.reelyze.com

/v2/users

Retrieves a list of users, filtered based on optional querystring parameters. Parameters shown are examples, but any user property can be supplied as a query filter.

Query Users › query Parameters

emailstring
Filter by email address
phoneNumberstring
Filter by phone number (international format, e.g. +447777123456)

Query Users › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Users › Responses

idstring · required
firstNamestring · required
lastNamestring · required
displayNamestring · required
rolestring · enum · required
Enum values:
user
creator
manager
admin

organisationIdstring
invitationStatusstring · enum
Enum values:
accepted
none
pending
requested
avatarUrlstring
emailstring
phoneNumberstring
jobRolestring
departmentIdstring
isOnboardingCompleteboolean
sourcestring · enum
Enum values:
manual
integration
organisationNamestring
departmentNamestring
lastActiveobject

Create User

POST

https://developer-api.reelyze.com

/v2/users

Creates a new user. Users must have at least one identity property (email / phoneNumber) specified.

Create User › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Create User › Request Body

Create User › Responses

Created

idstring · required
firstNamestring · required
lastNamestring · required
displayNamestring · required
rolestring · enum · required
Enum values:
user
creator
manager
admin

organisationIdstring
invitationStatusstring · enum
Enum values:
none
requested
pending
accepted
avatarUrlstring
emailstring
phoneNumberstring
jobRolestring
departmentIdstring

Get User

GET

https://developer-api.reelyze.com

/v2/users/{id}

Retrieves details for a user

Get User › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get User › Responses

idstring · required
firstNamestring · required
lastNamestring · required
displayNamestring · required
rolestring · enum · required
Enum values:
user
creator
manager
admin

organisationIdstring
invitationStatusstring · enum
Enum values:
none
requested
pending
accepted
avatarUrlstring
emailstring
phoneNumberstring
jobRolestring
departmentIdstring

Delete User

DELETE

https://developer-api.reelyze.com

/v2/users/{id}

Deletes the specified user

Delete User › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Delete User › Responses

No Content

No data returned

Update User

PATCH

https://developer-api.reelyze.com

/v2/users/{id}

Update details for the specified user

Update User › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update User › Request Body

Update User › Responses

Updated user state

idstring · required
firstNamestring · required
lastNamestring · required
displayNamestring · required
rolestring · enum · required
Enum values:
user
creator
manager
admin

organisationIdstring
invitationStatusstring · enum
Enum values:
none
requested
pending
accepted
avatarUrlstring
emailstring
phoneNumberstring
jobRolestring
departmentIdstring