Workplace from Meta desaparecerá pronto. Podrás seguir usando Workplace hasta el 31 de agosto de 2025. Visita nuestro Servicio de ayuda para obtener más información.

Miembro

Objeto `/{member-id}` de la ruta

Representa un objeto de usuario como miembro de una comunidad o un grupo de Workplace.

Ruta `/community/members`

Devuelve una lista de todas las cuentas de usuario actuales. Requiere el permiso Administrar perfiles laborales.

Filtración en función de `external_id`

Para filtrar usuarios en función del identificador externo, usa el parámetro external_ids y pasa una lista separada por comas con los identificadores externos de los usuarios deseados.

Ruta `/community/organization_members`

Devuelve una lista de usuarios. Requiere el permiso Leer miembros de grupo. De forma predeterminada, se enumerarán las cuentas de usuario activas. Para mostrar las cuentas de usuario desactivadas, usa el parámetro de URL inactive=1 en su lugar.

Lectura

Devuelve un único objeto de usuario que representa a un usuario de Workplace. Es accesible a través del identificador de Workplace del miembro o de la dirección de correo electrónico que utiliza el miembro para iniciar sesión en Workplace.

/{member_id}
/{email_address}

Permisos

Para leer la información sobre un miembro, es necesario el permiso Leer el perfil laboral o el permiso Administrar cuentas. Si una integración usa el permiso Administrar cuentas y se centra en grupos específicos, no podrá acceder a algunos campos de Miembro.

Campos

Nombre del campo	Descripción	Tipo
`id`	Identificador de la cuenta de usuario de esta persona.	`string`
`first_name`	Nombre de la persona.	`string`
`last_name`	Apellidos de la persona.	`string`
`email`	Dirección de correo electrónico principal de la persona, que también se utiliza como su nombre de usuario en Workplace.	`string`
`title`	Cargo de la persona en Workplace, si se establece mediante la API de administración de cuentas.	`string`
`organization`	Organización de la persona en Workplace, si se establece mediante la API de administración de cuentas.	`string`
`division`	División de la persona en Workplace, si se establece mediante la API de administración de cuentas.	`string`
`department`	Nombre del departamento de la persona en Workplace, si se establece mediante la API de administración de cuentas.	`string`
`primary_phone`	Número de teléfono principal de la persona. Se asigna a la entrada `phoneNumbers`, que está marcada como `primary` en la API de administración de cuentas.	`string`
`primary_address`	Dirección principal de la persona. Se asigna a la entrada `addresses`, marcada como `primary` en la API de administración de cuentas.	`string`
`picture`	Foto del perfil de la persona.	`url`
`link`	Enlace al perfil de la persona.	`url`
`locale`	Configuración regional de la persona.	`string`
`name`	Nombre completo de la persona.	`string`
`name_format`	Nombre de la persona formateado correctamente para gestionar pedidos chinos, japoneses o coreanos.	`string`
`updated_time`	Fecha de actualización.	`datetime`
`account_invite_time`	Hora de invitación de la cuenta en formato UTC.	`datetime`
`account_claim_time`	Hora de reclamación de la cuenta en formato UTC.	`datetime`
`account_deactivate_time`	Hora de desactivación de la cuenta en formato UTC.	`datetime`
`external_id`	Identificador del miembro según lo haya definido el cliente. Los miembros PUEDEN incluir un conjunto de valores external_id que no esté vacío mediante la API de administración de cuentas. Workplace nunca especificará el valor del atributo external_id.	`string`
`start_date`	Fecha y hora en que la persona se unió a la empresa, si se establece mediante la API de administración de cuentas.	`datetime`
`about`	Biografía de la persona.	`string`
`cost_center`	Identifica el nombre de un centro de costes.	`string`
`impersonate_token`	Identificador de acceso de un miembro que permite que una integración realice llamadas en nombre de una persona específica. El permiso de suplantación está obsoleto. No lo utilices al compilar nuevas funcionalidades. Este permiso solo está disponible para las integraciones personalizadas que lo tengan activado actualmente.	`string`
`claim_link`	Proporciona un enlace que un usuario puede seguir para reclamar su cuenta de Workplace (solo está disponible para los usuarios sin reclamar).	`string`
`access_code`	Proporciona un código de acceso que un usuario puede seguir para reclamar su cuenta de Workplace (solo está disponible para los usuarios sin reclamar).	`string`
`work_locale`	Configuración regional del usuario. Es la configuración regional que Workplace usará para este usuario hasta que haya otra forma de determinar la configuración regional del usuario (como la configuración de idioma del navegador o el dispositivo).	`string` Los valores válidos son una concatenación del código de idioma de dos letras según la ISO 639-1 seguido de un guion bajo más el código de país de dos letras según la ISO 3166-1. Por ejemplo, en_US especifica el idioma inglés y el país Estados Unidos.
`frontline`	Información sobre el estado de primera línea del usuario.	`object` (consulta el ejemplo a continuación)
`active`	Si la cuenta de usuario está activa.	`boolean`

Publicación

Consulta API de administración de cuentas (Graph).

Eliminación

Consulta API de administración de cuentas (Graph).

Actualización

Consulta API de administración de cuentas (Graph).

Perímetros

Nombre del perímetro	Descripción
`/events`	Eventos para esta persona. De forma predeterminada, no se incluyen eventos que la persona ha rechazado o a los que no ha respondido.
`/feed`	Sección de noticias de las publicaciones (incluidas las actualizaciones de estado) y enlaces publicados por esta persona.
`/conversations`	Mensajes de Workplace de la página de un bot o una persona. Requiere el permiso Leer todos los mensajes para ver las conversaciones de una persona.
`/managers`	Administrador o administradores enumerados de una persona.
`/reports`	Informes enumerados de una persona.
`/photos`	Fotos de perfil del miembro.
`/groups`	Grupos asociados a un miembro.
`/phones`	Números de teléfono asociados a un miembro.
`/skills`	Aptitudes de un miembro.
`/badges`	Insignias otorgadas al usuario.
`/logout`	Cierra la sesión de un usuario en Workplace. Solo `POST`.
`/remove_profile_information`	Elimina la información de perfil de un usuario desactivado. Solo `POST`.

Ejemplos

Recuperar información sobre un miembro de la comunidad

Obtener el nombre y la dirección de correo electrónico de un miembro determinado

GET /{member_id}?fields=email,name HTTP/1.1
Host: graph.facebook.com

Obtener el identificador de un miembro a partir de su dirección de correo electrónico

GET /{email_address} HTTP/1.1
Host: graph.facebook.com

Publicar los miembros de una empresa en función del identificador externo de los usuarios

GET /community/members?external_ids=12356,abc123 HTTP/1.1
Host: graph.facebook.com

Publicar los miembros de una empresa, incluidas las cuentas desactivadas

GET /community/organization_members?inactive=1 HTTP/1.1
Host: graph.facebook.com

Obtener los eventos de un miembro:

GET graph.facebook.com
      /{member-id}/events

Recuperar información sobre el administrador y los informes del usuario

Obtener los informes de un miembro determinado

GET /{member_id}/reports HTTP/1.1
Host: graph.facebook.com

Obtener el administrador de un miembro determinado

GET /{member_id}/managers HTTP/1.1
Host: graph.facebook.com

Recuperar mensajes de un miembro

Obtener conversaciones de un miembro, incluidos los mensajes, el remitente y los archivos adjuntos

Requiere un identificador de integración personalizado con el permiso Leer todos los mensajes:

GET graph.facebook.com
      /{member-id}/conversations?fields=messages{message,attachments,from}

Obtener identificadores de conversación de un miembro por el hilo

Requiere un identificador de integración personalizado con el permiso Leer todos los mensajes:

GET graph.facebook.com
      /{member-id}/conversations

Obtener mensajes de un identificador de hilo determinado para un usuario específico

Requiere un identificador de integración personalizado con el permiso Leer todos los mensajes:

GET graph.facebook.com
      /{thread-id}/messages?user={user-id}

Obtener conversaciones de una página de bot, incluidos los mensajes y los archivos adjuntos

GET graph.facebook.com
      /me/conversations?fields=messages{message,attachments}

El alias /me señala la página del bot cuando se utiliza un identificador de integración personalizado.

Eliminar un mensaje específico en la bandeja de entrada de un miembro mediante un identificador de integración personalizado

Requiere un identificador de integración personalizado con el permiso Eliminar mensajes de chat:

DELETE graph.facebook.com
      /{message-id}?user={user-id}

Al eliminar un mensaje, este solo se elimina de la vista del miembro que se ha especificado en la solicitud. Para eliminar un mensaje completamente, la vista del mensaje se debe eliminar para todos los miembros.

Obtener la fecha y hora en que un miembro ha recibido una invitación y ha reclamado su cuenta

Requiere un identificador de integración personalizado con el permiso Administrar cuentas:

GET graph.facebook.com
      /{member-id}?fields=account_invite_time,account_claim_time

Estos campos solo están presentes si el miembro ha recibido una invitación o ha reclamado su cuenta.

Obtener la fecha y hora en que se ha desactivado la cuenta de un miembro:

Requiere un identificador de integración personalizado con el permiso Administrar cuentas:

GET graph.facebook.com
      /{member-id}?fields=account_deactivate_time

Estos campos solo están presentes si la cuenta del miembro se ha desactivado.

Cerrar la sesión de un usuario en Workplace

Requiere un identificador de acceso con el permiso Cerrar sesión:

POST graph.facebook.com
      /{member-id}/logout

Establecer una foto de perfil

Requiere un identificador de acceso con el permiso Administrar perfiles laborales. Admite una URL de archivo y la subida de archivos dentro de la solicitud.

POST graph.facebook.com
      /{member-id}/profile_pictures?
      image_url={...}&
      caption={...}

POST graph.facebook.com
      /{member-id}/profile_pictures?
      caption={...}
Content-Type: multipart/form-data;
Content-Disposition: form-data; name="image_data"; filename="/profile_picture.png

Añadir el teléfono de un miembro

Requiere un identificador de acceso con el permiso Administrar perfiles laborales.

POST graph.facebook.com
      /{member-id}/phones?
      type={...}&
      primary={...}&
      number={...}

Obtener las aptitudes de un miembro

Requiere un identificador de acceso con el permiso Leer el perfil laboral.

GET graph.facebook.com
      /{member-id}/skills

Añadir una aptitud

Requiere un identificador de acceso con el permiso Administrar perfil laboral.

POST graph.facebook.com
      /{member-id}/skills?name={...}

Eliminar una aptitud

Requiere un identificador de acceso con el permiso Administrar perfil laboral.

DELETE graph.facebook.com
      /{member-id}/skills?name={...}

Obtener las insignias de un miembro

Requiere un identificador de acceso con el permiso Leer el perfil laboral.

GET graph.facebook.com
      /{member-id}/badges?fields=id,name,description,icon,category

Otorgar una insignia integrada a un usuario

Requiere un identificador de acceso con el permiso Administrar insignias. Consulta la documentación sobre la comunidad para saber cómo obtener una lista con las insignias disponibles y sus identificadores.

POST graph.facebook.com
      /{member-id}/badges?badge=workplace_champion

Otorgar una insignia personalizada a un usuario

Requiere un identificador de acceso con el permiso Administrar insignias. Consulta la documentación sobre la comunidad para obtener información sobre las insignias disponibles y sus identificadores. Ten en cuenta que el carácter # de la URL debe tener codificación URL.

POST graph.facebook.com
      /{member-id}/badges?badge=workplace_custom#{badge_id}

Desactivar un miembro

Requiere un identificador de acceso con el permiso Crear cuentas de usuario.

POST graph.facebook.com
      /{member-id}?active=false

Eliminar un miembro

Requiere un identificador de acceso con el permiso Crear cuentas de usuario.

DELETE graph.facebook.com
      /{member-id}

Solo los miembros sin reclamar están disponibles para la eliminación.

Obtener el estado de primera línea del usuario

GET graph.facebook.com
      /{user-id}?fields=frontline
      
    {
      "frontline": {
        "is_frontline": true
      },
    "id": "100038142594104"
    }

Miembro

Objeto /{member-id} de la ruta

Ruta /community/members

Filtración en función de external_id

Ruta /community/organization_members

Lectura

Permisos

Campos

Publicación

Eliminación

Actualización

Perímetros

Ejemplos

Recuperar información sobre un miembro de la comunidad

Obtener el nombre y la dirección de correo electrónico de un miembro determinado

Obtener el identificador de un miembro a partir de su dirección de correo electrónico

Publicar los miembros de una empresa en función del identificador externo de los usuarios

Publicar los miembros de una empresa, incluidas las cuentas desactivadas

Obtener los eventos de un miembro:

Recuperar información sobre el administrador y los informes del usuario

Obtener los informes de un miembro determinado

Obtener el administrador de un miembro determinado

Recuperar mensajes de un miembro

Obtener conversaciones de un miembro, incluidos los mensajes, el remitente y los archivos adjuntos

Obtener identificadores de conversación de un miembro por el hilo

Obtener mensajes de un identificador de hilo determinado para un usuario específico

Obtener conversaciones de una página de bot, incluidos los mensajes y los archivos adjuntos

Eliminar un mensaje específico en la bandeja de entrada de un miembro mediante un identificador de integración personalizado

Obtener la fecha y hora en que un miembro ha recibido una invitación y ha reclamado su cuenta

Obtener la fecha y hora en que se ha desactivado la cuenta de un miembro:

Cerrar la sesión de un usuario en Workplace

Establecer una foto de perfil

Añadir el teléfono de un miembro

Obtener las aptitudes de un miembro

Añadir una aptitud

Eliminar una aptitud

Obtener las insignias de un miembro

Otorgar una insignia integrada a un usuario

Otorgar una insignia personalizada a un usuario

Desactivar un miembro

Eliminar un miembro

Obtener el estado de primera línea del usuario

Objeto `/{member-id}` de la ruta

Ruta `/community/members`

Filtración en función de `external_id`

Ruta `/community/organization_members`