Users

Users API v3

Documentación de la API de users

API Versión v3

Todos los endpoints estan disponibles bajo el prefijo /v3, con respuestas que siguen el estandar AIP.

Servidor base: https://services.leadconnectorhq.com

Endpoints

• GET /users/search — Buscar usuarios
• POST /users/search/filter-by-email — Filter Users by Email
• GET /users/{userId} — Obtener usuario
• PUT /users/{userId} — Actualizar usuario
• DELETE /users/{userId} — Eliminar usuario
• POST /users/ — Crear usuario

GET /users/search

Buscar usuarios Scopes requeridos: users.readonly, users.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - companyId (query, string) (requerido) — Company Id in which the search needs to be performed - query (query, string) — The search term for the user is matched based on the user full name, email or phone - skip (query, string) — No of results to be skipped before returning the result - limit (query, string) — No of results to be limited before returning the result - locationId (query, string) — Location Id in which the search needs to be performed - type (query, string) — Type of the users to be filtered in the search - role (query, string) — Role of the users to be filtered in the search - ids (query, string) — List of User IDs to be filtered in the search - sort (query, string) — The field on which sort is applied in which the results need to be sorted. Default is based on the first and last name - sortDirection (query, string) — The direction in which the results need to be sorted - enabled2waySync (query, boolean) — Filter users by whether 2-way sync is enabled

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /users/search/filter-by-email

Filter Users by Email Filter users by company Id, deleted status, and email array

Scopes requeridos: users.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - companyId (requerido) — string — Company Id to filter users - emails (requerido) — string — Comma-separated list of email addresses to filter users - deleted — boolean — Filter deleted users - skip — string — No of results to be skipped before returning the result - limit — string — No of results to be limited before returning the result - projection — string — Projection fields to return. Use "all" for all fields, or specify comma-separated field names. Default returns only id and email

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /users/{userId}

Obtener usuario Scopes requeridos: users.readonly, users.readonly

Parametros: - userId (path, string) (requerido) — Id de usuario - Versión (header, string) (requerido) — Versión de la API

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /users/{userId}

Actualizar usuario Scopes requeridos: users.write, users.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - firstName — string — First name of the user - lastName — string — Last name of the user - email — string — Email update is no longer supported due to security reasons. - password — string — New password for the user account. All passwords will be required to meet the following criteria:

• Minimum 12 characters
• At least one uppercase letter (A–Z)
• At least one lowercase letter (a–z)
• At least one number (0–9)
• At least one special character (e.g., !, @, #, $)
• phone — string — Phone number of the user in E.164 format
• type — string — User account type (account for sub-account users, agency for agency-level users)
• role — string — User role within the account (admin or user)
• companyId — string — Company/Agency Id. Required for Agency Level access
• locationIds — array — List of sub-account location IDs the user should have access to
• permissions — — User permissions controlling access to various features
• scopes — array — Scopes allowed for users. Only scopes that have been passed will be enabled. If passed empty all the scopes will be get disabled
• scopesAssignedToOnly — array — Assigned Scopes allowed for users. Only scopes that have been passed will be enabled. If passed empty all the assigned scopes will be get disabled
• profilePhoto — string — URL of the user profile photo
• twilioPhone — object — Per-location inbound Twilio number in E.164 format, keyed by location id (Call and Voicemail Inbound Number for direct Twilio, not LC Phone). Replacement semantics: if you send twilioPhone in the request body, the stored map is replaced entirely with this object (not merged). Any location id omitted from the object is removed from the saved map. Omit the twilioPhone property entirely to leave existing numbers unchanged. Send an empty object {} to clear all per-location numbers. To clear a single location only, set that location id to an empty string "".
• platformLanguage — string — Platform language preference for the user

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /users/{userId}

Eliminar usuario Scopes requeridos: users.write, users.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /users/

Crear usuario Scopes requeridos: users.write, users.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - companyId (requerido) — string — Company/Agency Id to associate the user with - email (requerido) — string — Email address of the user (used for login) - password (requerido) — string — Password for the user account. All passwords will be required to meet the following criteria:

• Minimum 12 characters
• At least one uppercase letter (A–Z)
• At least one lowercase letter (a–z)
• At least one number (0–9)
• At least one special character (e.g., !, @, #, $)
• phone — string — Phone number of the user in E.164 format
• type (requerido) — string — User account type (account for sub-account users, agency for agency-level users)
• role (requerido) — string — User role within the account (admin or user)
• locationIds (requerido) — array — List of location IDs to assign to the user
• permissions — — User permissions controlling access to various features
• scopes — array — Scopes allowed for users. Only scopes that have been passed will be enabled. Note:- If passed empty all the scopes will be get disabled
• scopesAssignedToOnly — array — Assigned Scopes allowed for users. Only scopes that have been passed will be enabled. If passed empty all the assigned scopes will be get disabled
• profilePhoto — string — URL of the user profile photo
• twilioPhone — object — Per-location inbound Twilio number in E.164 format, keyed by location id (Call and Voicemail Inbound Number for direct Twilio, not LC Phone). Replacement semantics: if you send twilioPhone in the request body, the stored map is replaced entirely with this object (not merged). Any location id omitted from the object is removed from the saved map. Omit the twilioPhone property entirely to leave existing numbers unchanged. Send an empty object {} to clear all per-location numbers. To clear a single location only, set that location id to an empty string "".
• platformLanguage — string — Platform language preference for the user
• firstName (requerido) — string — First name of the user
• lastName (requerido) — string — Last name of the user

Respuestas: - 201 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable