Meridian raises $7M seed round led by 645 Ventures.
Read More
Product
Solutions
The Users API allows you to manage user accounts and permissions within the Meridian CRM system.
All requests must include a Bearer token in the HTTP header:
Description: Retrieve a list of users from the user's organization.
Endpoint: GET api/public/v1/users/
Optional Query Parameters:
Response Example:
Description: Retrieve details for a specific user.
Endpoint: GET api/public/v1/users/{id}/
Response Example:
Description: Retrieve details for the currently authenticated user.
Endpoint: GET api/public/v1/users/me/
Response: Returns the user object for the currently authenticated user.
Description: Create a new user.
Endpoint: POST api/public/v1/users/
Request Example:
Response: Returns the created user object with HTTP 201 status code.
Description: Update an existing user.
Endpoint: PUT api/public/v1/users/{id}/
Request Example:
Response: Returns the updated user object.
Description: Deactivate a user (soft delete).
Endpoint: POST api/public/v1/users/{id}/deactivate/
Response: Returns HTTP 200 OK on success.
Description: Reactivate a previously deactivated user.
Endpoint: POST api/public/v1/users/{id}/reactivate/
Response: Returns HTTP 200 OK on success.
Description: Update permissions for a user.
Endpoint: PUT api/public/v1/users/{id}/permissions/
Request Example:
Response: Returns the updated user permissions with HTTP 200 OK status code.
Description: Upload a profile picture for a user.
Endpoint: POST api/public/v1/users/{id}/profile-picture/
Request Example:
Response: Returns the updated user object with the new profile picture URL.
Description: Retrieve a list of organizations the user has access to.
Endpoint: GET api/public/v1/organizations/
Response Example:
Description: Retrieve details for a specific organization.
Endpoint: GET api/public/v1/organizations/{id}/
Response Example:
Description: Update an existing organization.
Endpoint: PUT api/public/v1/organizations/{id}/
Request Example:
Response: Returns the updated organization object.
Description: Upload a logo for an organization.
Endpoint: POST api/public/v1/organizations/{id}/logo/
Request Example:
Response: Returns the updated organization object with the new logo URL.
Description: Send an invitation to a user to join an organization.
Endpoint: POST api/public/v1/organizations/{id}/invite/
Request Example:
Response: Returns the created invitation object with HTTP 201 status code.
Description: Retrieve a list of pending invitations for an organization.
Endpoint: GET api/public/v1/organizations/{id}/invitations/
Response Example:
Description: Cancel a pending invitation.
Endpoint: DELETE api/public/v1/organizations/invitations/{id}/
Response: Returns HTTP 204 No Content on success.
Description: Accept an invitation to join an organization.
Endpoint: POST api/public/v1/organizations/invitations/{id}/accept/
Response: Returns HTTP 200 OK on success.
Description: Retrieve metadata about user fields, including field names, types, and whether they are required, createable, or updateable.
Endpoint: GET api/public/v1/users/metadata/fields/
Response Example:
Description: Retrieve metadata about organization fields.
Endpoint: GET api/public/v1/organizations/metadata/fields/
Response Example:
Description: Retrieve metadata about invitation fields.
Endpoint: GET api/public/v1/organizations/invitations/metadata/fields/
Response Example: