Compartir a través de


Envoy (versión preliminar)

Un conector de Envoy que le permite poder conectar su cuenta de Envoy (nuestros puntos de conexión de API REST) a cualquier otro conector. Un ejemplo sería crear invitaciones masivas en Envoy con detalles de una hoja de cálculo de Microsoft Excel Online.

Este conector está disponible en los siguientes productos y regiones:

Service Class Regions
Copilot Studio Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas Estándar Todas las regiones de Logic Apps excepto las siguientes:
     - Regiones de Azure Government
     - Regiones de Azure China
     - Departamento de Defensa de EE. UU. (DoD)
Power Apps Premium Todas las regiones de Power Apps excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Power Automate Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Contacto
Nombre Equipo de soporte técnico de Envoy
URL https://envoy.help/
Correo Electrónico hi@envoy.com
Metadatos del conector
Publicador Envoy, Inc.
Sitio web https://envoy.com/
Directiva de privacidad https://envoy.com/privacypolicy/
Categorías Business Intelligence; Datos

En la versión 2.0, también puede usar la creación de invitación de Envoy como desencadenador.

Prerrequisitos

Para usar este conector, necesitará una cuenta de Envoy con el nombre de usuario y la contraseña. Para desencadenar la funcionalidad, también tendrá que instalar la integración de Envoy "Microsoft Flow".

Obtención de credenciales

Para autenticarse en Envoy, necesitará su nombre de usuario y contraseña de Envoy.

Para desencadenar la funcionalidad, necesitará el token de instalación proporcionado durante el paso 2 de la configuración de integración de "Microsoft Flow" en Envoy.

Problemas y limitaciones conocidos

En este momento, el único desencadenador disponible es Invite Creation. Esperamos agregar más desencadenadores en el futuro próximo.

Creación de una conexión

El conector admite los siguientes tipos de autenticación:

Predeterminado Parámetros para crear una conexión. Todas las regiones No se puede compartir

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Nombre Tipo Description Obligatorio
nombre de usuario securestring El nombre de usuario de esta API Cierto
contraseña securestring La contraseña de esta API Cierto

Limitaciones

Nombre Llamadas Período de renovación
Llamadas API por conexión 100 60 segundos

Acciones

Actualizar una invitación

Solicitud PATCH para actualizar la información de una invitación.

Agregar filtro de lista de bloqueados

Solicitud POST para agregar un filtro de lista de bloques

Crear invitaciones

Esta es la solicitud POST para crear una invitación.

Obtención de filtros de lista de bloqueo

Solicitud GET para recuperar filtros de lista de bloqueos.

Obtener flujos

Solicitud GET para recuperar información sobre los flujos de la ubicación.

Obtener información de la empresa

Recuperar información sobre la empresa (GET)

Obtener invitaciones

Solicitud GET para recuperar información de invitación basada en el filtrado.

Obtener la lista de empleados

Solicitud GET para recuperar la lista de empleados

Obtener ubicaciones

Solicitud GET para recuperar ubicaciones

Obtener una entrada

Solicitud GET para recuperar información sobre una sola entrada.

Obtener una invitación

Solicitud GET para recuperar información sobre una sola invitación.

Actualizar una invitación

Solicitud PATCH para actualizar la información de una invitación.

Parámetros

Nombre Clave Requerido Tipo Description
invite_id
invite_id True string

invite_id

Tipo de contenido
Content-Type string

Tipo de contenido

id
id string

id

nombre completo
full-name string

nombre completo

Correo electrónico
email string

Correo electrónico

inviter-name
inviter-name string

inviter-name

hora prevista de llegada
expected-arrival-time string

hora prevista de llegada (formato esperado: 2019-03-24T21:15:00.000Z)

regla periódica
recurring-rule string

regla periódica

rrule-until
rrule-until string

rrule-until

notas privadas
private-notes string

notas privadas

been-here-before
been-here-before boolean

been-here-before

invitados adicionales
additional-guests integer

invitados adicionales

skip-guest-notification
skip-guest-notification boolean

skip-guest-notification

Nda
nda string

Nda

guest-updated-at
guest-updated-at string

guest-updated-at (Formato: 2019-03-24T21:15:00.000Z)

original-nda-sign-date
original-nda-sign-date string

original-nda-sign-date

Disponible en nda
nda-available boolean

Disponible en nda

flow-name
flow-name string

flow-name

llegado
arrived boolean

llegado

estado de aprobación
approval-status string

estado de aprobación

campo
field string

campo

value
value string

value

type
type string

type

id
id string

id

type
type string

type

id
id string

id (empleado)

type
type string

type

id
id string

id (ubicación)

type
type string

type

Devoluciones

Nombre Ruta de acceso Tipo Description
id
data.id string

id

type
data.type string

type

agreement-status
data.attributes.agreements-status string

agreement-status

nombre completo
data.attributes.full-name string

nombre completo

Correo electrónico
data.attributes.email string

Correo electrónico

inviter-name
data.attributes.inviter-name string

inviter-name

inviter-email
data.attributes.inviter-email string

inviter-email

hora prevista de llegada
data.attributes.expected-arrival-time string

hora prevista de llegada

notas privadas
data.attributes.private-notes string

notas privadas

llegado
data.attributes.arrived boolean

llegado

been-here-before
data.attributes.been-here-before boolean

been-here-before

flow-name
data.attributes.flow-name string

flow-name

flow-id
data.attributes.flow-id integer

flow-id

datos de usuario
data.attributes.user-data array of object

datos de usuario

campo
data.attributes.user-data.field string

campo

value
data.attributes.user-data.value string

value

invitados adicionales
data.attributes.additional-guests integer

invitados adicionales

guest-updated-at
data.attributes.guest-updated-at string

guest-updated-at

Nda
data.attributes.nda string

Nda

Disponible en nda
data.attributes.nda-available boolean

Disponible en nda

original-nda-sign-date
data.attributes.original-nda-sign-date string

original-nda-sign-date

secret-token
data.attributes.secret-token string

secret-token

group-name
data.attributes.group-name string

group-name

photo-url
data.attributes.photo-url string

photo-url

código qr
data.attributes.qr-code string

código qr

qr-code-sent-at
data.attributes.qr-code-sent-at string

qr-code-sent-at

preregistration-complete
data.attributes.preregistration-complete string

preregistration-complete

estado
data.attributes.approval-status.status string

estado

auto-aprobado
data.attributes.approval-status.auto-approved boolean

auto-aprobado

report
data.attributes.approval-status.report array of object

report

resultado
data.attributes.approval-status.report.result string

resultado

source
data.attributes.approval-status.report.source string

source

blacklistReportUUID
data.attributes.approval-status.report.blacklistReportUUID string

blacklistReportUUID

reason
data.attributes.approval-status.report.reason string

reason

texto
data.attributes.approval-status.report.messages.failure.text string

texto

encabezado
data.attributes.approval-status.report.messages.failure.header string

encabezado

reviewer-id
data.attributes.approval-status.reviewer-id string

reviewer-id

reviewer-name
data.attributes.approval-status.reviewer-name string

reviewer-name

review-note
data.attributes.approval-status.review-note string

review-note

revisado en
data.attributes.approval-status.reviewed-at string

revisado en

type
data.relationships.entry.data.type string

type

id
data.relationships.entry.data.id string

id

id
data.relationships.location.data.id string

id

type
data.relationships.location.data.type string

type

type
data.relationships.flow.data.type string

type

id
data.relationships.flow.data.id string

id

type
data.relationships.employee.data.type string

type

id
data.relationships.employee.data.id string

id

type
data.relationships.creator.data.type string

type

id
data.relationships.creator.data.id string

id

relacionado
data.relationships.platform-jobs.links.related string

relacionado

incluido
included array of object

incluido

id
included.id string

id

type
included.type string

type

nombre
included.attributes.name string

nombre

propio
links.self string

propio

Agregar filtro de lista de bloqueados

Solicitud POST para agregar un filtro de lista de bloques

Parámetros

Nombre Clave Requerido Tipo Description
aliases
aliases array of

aliases

descripción
description string

descripción

correos electrónicos
emails array of string

correos electrónicos

nombre completo
full-name string

nombre completo

palabra clave
keyword string

palabra clave

otras palabras clave
other-keywords array of

otras palabras clave

reason
reason string

reason

números de teléfono
phone-numbers array of

números de teléfono

type
type string

type

id
id string

id (ubicación)

type
type string

type

Devoluciones

Nombre Ruta de acceso Tipo Description
id
data.id string

id

type
data.type string

type

propio
data.links.self string

propio

aliases
data.attributes.aliases array of

aliases

descripción
data.attributes.description string

descripción

correos electrónicos
data.attributes.emails array of string

correos electrónicos

nombre completo
data.attributes.full-name string

nombre completo

palabra clave
data.attributes.keyword string

palabra clave

otras palabras clave
data.attributes.other-keywords array of

otras palabras clave

números de teléfono
data.attributes.phone-numbers array of

números de teléfono

Texto original en
data.attributes.photo.original string

Texto original en

pulgar
data.attributes.photo.thumb string

pulgar

reason
data.attributes.reason string

reason

creado por
data.attributes.created-by string

creado por

propio
data.relationships.location.links.self string

propio

relacionado
data.relationships.location.links.related string

relacionado

propio
data.relationships.user.links.self string

propio

relacionado
data.relationships.user.links.related string

relacionado

Crear invitaciones

Esta es la solicitud POST para crear una invitación.

Parámetros

Nombre Clave Requerido Tipo Description
Tipo de contenido
Content-Type string

Tipo de contenido

nombre completo
full-name string

nombre completo

Correo electrónico
email string

Correo electrónico

inviter-name
inviter-name string

inviter-name

hora prevista de llegada
expected-arrival-time string

hora prevista de llegada

regla periódica
recurring-rule string

regla periódica

rrule-until
rrule-until string

rrule-until

notas privadas
private-notes string

notas privadas

been-here-before
been-here-before boolean

been-here-before

invitados adicionales
additional-guests integer

invitados adicionales

skip-guest-notification
skip-guest-notification boolean

skip-guest-notification

agreement-status
agreements-status string

agreement-status

place-id
place-id string

place-id

flow-name
flow-name string

flow-name

group-name
group-name string

group-name

llegado
arrived boolean

llegado

estado de aprobación
approval-status string

estado de aprobación

campo
field string

campo

value
value string

value

type
type string

type

id
id string

id (empleado)

type
type string

type

id
id string

id (ubicación)

type
type string

type

Devoluciones

Nombre Ruta de acceso Tipo Description
id
data.id string

id

type
data.type string

type

propio
data.links.self string

propio

invitados adicionales
data.attributes.additional-guests integer

invitados adicionales

estado
data.attributes.approval-status.status string

estado

auto_approved
data.attributes.approval-status.auto_approved boolean

auto_approved

report
data.attributes.approval-status.report array of object

report

resultado
data.attributes.approval-status.report.result string

resultado

source
data.attributes.approval-status.report.source string

source

blacklistReportUUID
data.attributes.approval-status.report.blacklistReportUUID string

blacklistReportUUID

reason
data.attributes.approval-status.report.reason string

reason

texto
data.attributes.approval-status.report.messages.failure.text string

texto

encabezado
data.attributes.approval-status.report.messages.failure.header string

encabezado

reviewer_id
data.attributes.approval-status.reviewer_id string

reviewer_id

reviewer_name
data.attributes.approval-status.reviewer_name string

reviewer_name

review_note
data.attributes.approval-status.review_note string

review_note

reviewed_at
data.attributes.approval-status.reviewed_at string

reviewed_at

Correo electrónico
data.attributes.email string

Correo electrónico

hora prevista de llegada
data.attributes.expected-arrival-time string

hora prevista de llegada

hora prevista de salida
data.attributes.expected-departure-time string

hora prevista de salida

nombre completo
data.attributes.full-name string

nombre completo

guest-updated-at
data.attributes.guest-updated-at string

guest-updated-at

is-presigned
data.attributes.is-presigned boolean

is-presigned

address
data.attributes.location-info.address string

address

id
data.attributes.location-info.id integer

id

nombre
data.attributes.location-info.name string

nombre

logo_url
data.attributes.location-info.logo_url string

logo_url

notas privadas
data.attributes.private-notes string

notas privadas

datos de usuario
data.attributes.user-data array of object

datos de usuario

data.attributes.user-data.field string

campo

data.attributes.user-data.value string

value

notify-visitor
data.attributes.notify-visitor boolean

notify-visitor

creado a partir de
data.attributes.created-from string

creado a partir de

llegado
data.attributes.arrived boolean

llegado

touchless-sign-in-available-time
data.attributes.touchless-sign-in-available-time string

touchless-sign-in-available-time

touchless-sign-in-presence-required
data.attributes.touchless-sign-in-presence-required boolean

touchless-sign-in-presence-required

entry-signed-out-at
data.attributes.entry-signed-out-at string

entry-signed-out-at

preregistration-link
data.attributes.preregistration-link string

preregistration-link

created-at
data.attributes.created-at string

created-at

updated-at
data.attributes.updated-at string

updated-at

propio
data.relationships.attendee.links.self string

propio

relacionado
data.relationships.attendee.links.related string

relacionado

propio
data.relationships.creator.links.self string

propio

relacionado
data.relationships.creator.links.related string

relacionado

propio
data.relationships.employee.links.self string

propio

relacionado
data.relationships.employee.links.related string

relacionado

type
data.relationships.employee.data.type string

type

id
data.relationships.employee.data.id string

id

propio
data.relationships.entry.links.self string

propio

relacionado
data.relationships.entry.links.related string

relacionado

type
data.relationships.entry.data.type object

type

id
data.relationships.entry.data.id string

id

propio
data.relationships.flow.links.self string

propio

relacionado
data.relationships.flow.links.related string

relacionado

type
data.relationships.flow.data.type string

type

id
data.relationships.flow.data.id string

id

propio
data.relationships.location.links.self string

propio

relacionado
data.relationships.location.links.related string

relacionado

type
data.relationships.location.data.type string

type

id
data.relationships.location.data.id string

id

propio
data.relationships.platform-jobs.links.self string

propio

relacionado
data.relationships.platform-jobs.links.related string

relacionado

Obtención de filtros de lista de bloqueo

Solicitud GET para recuperar filtros de lista de bloqueos.

Parámetros

Nombre Clave Requerido Tipo Description
filter[company]
filter[company] integer

filter[company]

Tipo de contenido
Content-Type string

Tipo de contenido

Devoluciones

Nombre Ruta de acceso Tipo Description
datos
data array of object

datos

id
data.id string

id

type
data.type string

type

propio
data.links.self string

propio

aliases
data.attributes.aliases array of

aliases

descripción
data.attributes.description string

descripción

correos electrónicos
data.attributes.emails array of string

correos electrónicos

nombre completo
data.attributes.full-name string

nombre completo

palabra clave
data.attributes.keyword string

palabra clave

otras palabras clave
data.attributes.other-keywords array of string

otras palabras clave

números de teléfono
data.attributes.phone-numbers array of

números de teléfono

Texto original en
data.attributes.photo.original string

Texto original en

pulgar
data.attributes.photo.thumb string

pulgar

reason
data.attributes.reason string

reason

image-url
data.attributes.image-url string

image-url

external-id
data.attributes.external-id string

external-id

creado por
data.attributes.created-by string

creado por

propio
data.relationships.location.links.self string

propio

relacionado
data.relationships.location.links.related string

relacionado

propio
data.relationships.user.links.self string

propio

relacionado
data.relationships.user.links.related string

relacionado

total
meta.total integer

total

Obtener flujos

Solicitud GET para recuperar información sobre los flujos de la ubicación.

Parámetros

Nombre Clave Requerido Tipo Description
filter[location]
filter[location] integer

filter[location]

Devoluciones

Nombre Ruta de acceso Tipo Description
datos
data array of object

datos

id
data.id string

id

type
data.type string

type

propio
data.links.self string

propio

invitados adicionales
data.attributes.additional-guests boolean

invitados adicionales

auto-sign-out-minutes
data.attributes.auto-sign-out-minutes string

auto-sign-out-minutes

cierre de sesión automático a medianoche
data.attributes.auto-sign-out-at-midnight boolean

cierre de sesión automático a medianoche

distintivo habilitado
data.attributes.badge-enabled boolean

distintivo habilitado

enabled
data.attributes.enabled boolean

enabled

id-check
data.attributes.id-check boolean

id-check

ipad-localized-names
data.attributes.ipad-localized-names array of object

ipad-localized-names

language-code
data.attributes.ipad-localized-names.language-code string

language-code

código de región
data.attributes.ipad-localized-names.region-code string

código de región

display-name
data.attributes.ipad-localized-names.display-name string

display-name

nombre
data.attributes.name string

nombre

posición
data.attributes.position integer

posición

use-existing-photo
data.attributes.use-existing-photo boolean

use-existing-photo

created-at
data.attributes.created-at string

created-at

updated-at
data.attributes.updated-at string

updated-at

propio
data.relationships.agreement-page.links.self string

propio

relacionado
data.relationships.agreement-page.links.related string

relacionado

propio
data.relationships.badge.links.self string

propio

relacionado
data.relationships.badge.links.related string

relacionado

propio
data.relationships.location.links.self string

propio

relacionado
data.relationships.location.links.related string

relacionado

propio
data.relationships.photo-page.links.self string

propio

relacionado
data.relationships.photo-page.links.related string

relacionado

propio
data.relationships.sign-in-field-page.links.self string

propio

relacionado
data.relationships.sign-in-field-page.links.related string

relacionado

propio
data.relationships.summary-page.links.self string

propio

relacionado
data.relationships.summary-page.links.related string

relacionado

total
meta.total integer

total

Primero
links.first string

Primero

último
links.last string

último

Obtener información de la empresa

Recuperar información sobre la empresa (GET)

Parámetros

Nombre Clave Requerido Tipo Description
Aceptar
Accept string

Aceptar

Devoluciones

Nombre Ruta de acceso Tipo Description
total
meta.total integer

total

limit
meta.limit integer

limit

offset
meta.offset integer

offset

datos
data array of object

datos

id
data.id string

id

type
data.type string

type

nombre
data.attributes.name string

nombre

plan-intent
data.attributes.plan-intent string

plan-intent

buy-intent
data.attributes.buy-intent boolean

buy-intent

call-enabled
data.attributes.call-enabled boolean

call-enabled

appletv habilitado
data.attributes.appletv-enabled boolean

appletv habilitado

saml-connected
data.attributes.saml-connected boolean

saml-connected

activo
data.attributes.active boolean

activo

employees-sync-state
data.attributes.employees-sync-state string

employees-sync-state

employees-sync-provider
data.attributes.employees-sync-provider string

employees-sync-provider

employees-last-sync-at
data.attributes.employees-last-sync-at string

employees-last-sync-at

created-at
data.attributes.created-at string

created-at

updated-at
data.attributes.updated-at string

updated-at

estado de incorporación
data.attributes.onboarding-status string

estado de incorporación

onboarding-locations-count
data.attributes.onboarding-locations-count string

onboarding-locations-count

is-beta
data.attributes.is-beta boolean

is-beta

adhoc-plugins
data.attributes.adhoc-plugins array of

adhoc-plugins

cached-locations-quantity
data.attributes.cached-locations-quantity integer

cached-locations-quantity

type
data.relationships.subscription.data.type string

type

id
data.relationships.subscription.data.id string

id

type
data.relationships.deliveries-subscription.data.type string

type

id
data.relationships.deliveries-subscription.data.id string

id

datos
data.relationships.contracts.data array of object

datos

type
data.relationships.contracts.data.type string

type

id
data.relationships.contracts.data.id string

id

datos
data.relationships.administrators.data array of object

datos

type
data.relationships.administrators.data.type string

type

id
data.relationships.administrators.data.id string

id

datos
data.relationships.locations.data array of object

datos

type
data.relationships.locations.data.type string

type

id
data.relationships.locations.data.id string

id

type
data.relationships.saml.data.type string

type

id
data.relationships.saml.data.id string

id

propio
links.self string

propio

Primero
links.first string

Primero

último
links.last string

último

Obtener invitaciones

Solicitud GET para recuperar información de invitación basada en el filtrado.

Parámetros

Nombre Clave Requerido Tipo Description
filter[location]
filter[location] integer

filter[location]

filter[date]
filter[date] string

filter[date]

Aceptar
Accept string

Aceptar

Devoluciones

Nombre Ruta de acceso Tipo Description
datos
data array of object

datos

id
data.id string

id

type
data.type string

type

propio
data.links.self string

propio

invitados adicionales
data.attributes.additional-guests integer

invitados adicionales

estado
data.attributes.approval-status.status string

estado

auto_approved
data.attributes.approval-status.auto_approved boolean

auto_approved

report
data.attributes.approval-status.report array of object

report

resultado
data.attributes.approval-status.report.result string

resultado

source
data.attributes.approval-status.report.source string

source

blacklistReportUUID
data.attributes.approval-status.report.blacklistReportUUID string

blacklistReportUUID

reason
data.attributes.approval-status.report.reason string

reason

texto
data.attributes.approval-status.report.messages.failure.text string

texto

encabezado
data.attributes.approval-status.report.messages.failure.header string

encabezado

reviewer_id
data.attributes.approval-status.reviewer_id string

reviewer_id

reviewer_name
data.attributes.approval-status.reviewer_name string

reviewer_name

review_note
data.attributes.approval-status.review_note string

review_note

reviewed_at
data.attributes.approval-status.reviewed_at string

reviewed_at

Correo electrónico
data.attributes.email string

Correo electrónico

hora prevista de llegada
data.attributes.expected-arrival-time string

hora prevista de llegada

hora prevista de salida
data.attributes.expected-departure-time string

hora prevista de salida

nombre completo
data.attributes.full-name string

nombre completo

guest-updated-at
data.attributes.guest-updated-at string

guest-updated-at

is-presigned
data.attributes.is-presigned boolean

is-presigned

address
data.attributes.location-info.address string

address

id
data.attributes.location-info.id integer

id

nombre
data.attributes.location-info.name string

nombre

logo_url
data.attributes.location-info.logo_url string

logo_url

company_name
data.attributes.location-info.company_name string

company_name

timezone
data.attributes.location-info.timezone string

timezone

notas privadas
data.attributes.private-notes string

notas privadas

datos de usuario
data.attributes.user-data array of object

datos de usuario

campo
data.attributes.user-data.field string

campo

value
data.attributes.user-data.value string

value

notify-visitor
data.attributes.notify-visitor boolean

notify-visitor

creado a partir de
data.attributes.created-from string

creado a partir de

place_id
data.attributes.locality.place_id string

place_id

place-id
data.attributes.locality.place-id string

place-id

llegado
data.attributes.arrived boolean

llegado

touchless-sign-in-available-time
data.attributes.touchless-sign-in-available-time string

touchless-sign-in-available-time

touchless-sign-in-presence-required
data.attributes.touchless-sign-in-presence-required boolean

touchless-sign-in-presence-required

entry-signed-out-at
data.attributes.entry-signed-out-at string

entry-signed-out-at

Atestigua
data.attributes.attested string

Atestigua

phone
data.attributes.phone string

phone

preregistration-link
data.attributes.preregistration-link string

preregistration-link

preregistration-status-link
data.attributes.preregistration-status-link string

preregistration-status-link

reminder-sent-at
data.attributes.reminder-sent-at string

reminder-sent-at

created-at
data.attributes.created-at string

created-at

updated-at
data.attributes.updated-at string

updated-at

propio
data.relationships.attendee.links.self string

propio

relacionado
data.relationships.attendee.links.related string

relacionado

propio
data.relationships.creator.links.self string

propio

relacionado
data.relationships.creator.links.related string

relacionado

propio
data.relationships.employee.links.self string

propio

relacionado
data.relationships.employee.links.related string

relacionado

type
data.relationships.employee.data.type string

type

id
data.relationships.employee.data.id string

id

propio
data.relationships.entry.links.self string

propio

relacionado
data.relationships.entry.links.related string

relacionado

type
data.relationships.entry.data.type string

type

id
data.relationships.entry.data.id string

id

propio
data.relationships.flow.links.self string

propio

relacionado
data.relationships.flow.links.related string

relacionado

type
data.relationships.flow.data.type string

type

id
data.relationships.flow.data.id string

id

propio
data.relationships.location.links.self string

propio

relacionado
data.relationships.location.links.related string

relacionado

type
data.relationships.location.data.type string

type

id
data.relationships.location.data.id string

id

propio
data.relationships.platform-jobs.links.self string

propio

relacionado
data.relationships.platform-jobs.links.related string

relacionado

total
meta.total integer

total

Primero
links.first string

Primero

próximo
links.next string

próximo

último
links.last string

último

Obtener la lista de empleados

Solicitud GET para recuperar la lista de empleados

Devoluciones

Nombre Ruta de acceso Tipo Description
datos
data array of object

datos

id
data.id string

id

type
data.type string

type

propio
data.links.self string

propio

cc-employee
data.attributes.cc-employee boolean

cc-employee

company-id
data.attributes.company-id integer

company-id

eliminado
data.attributes.deleted boolean

eliminado

no sincronización
data.attributes.do-not-sync boolean

no sincronización

Correo electrónico
data.attributes.email string

Correo electrónico

hide-from-host-list
data.attributes.hide-from-host-list boolean

hide-from-host-list

agregado manualmente
data.attributes.manually-added boolean

agregado manualmente

manualmente added-location-present
data.attributes.manually-added-location-present boolean

manualmente added-location-present

nombre
data.attributes.name string

nombre

número de teléfono
data.attributes.phone-number string

número de teléfono

created-at
data.attributes.created-at string

created-at

deleted-at
data.attributes.deleted-at string

deleted-at

updated-at
data.attributes.updated-at string

updated-at

propio
data.relationships.company.links.self string

propio

relacionado
data.relationships.company.links.related string

relacionado

propio
data.relationships.user.links.self string

propio

relacionado
data.relationships.user.links.related string

relacionado

propio
data.relationships.assistants.links.self string

propio

relacionado
data.relationships.assistants.links.related string

relacionado

propio
data.relationships.bosses.links.self string

propio

relacionado
data.relationships.bosses.links.related string

relacionado

propio
data.relationships.employee-locations.links.self string

propio

relacionado
data.relationships.employee-locations.links.related string

relacionado

propio
data.relationships.locations.links.self string

propio

relacionado
data.relationships.locations.links.related string

relacionado

total
meta.total integer

total

Primero
links.first string

Primero

último
links.last string

último

Obtener ubicaciones

Solicitud GET para recuperar ubicaciones

Parámetros

Nombre Clave Requerido Tipo Description
Aceptar
Accept string

Aceptar

Devoluciones

Nombre Ruta de acceso Tipo Description
datos
data array of object

datos

id
data.id string

id

type
data.type string

type

propio
data.links.self string

propio

address
data.attributes.address string

address

address-line-one
data.attributes.address-line-one string

address-line-one

address-line-two
data.attributes.address-line-two string

address-line-two

cierre de sesión automático a medianoche
data.attributes.auto-sign-out-at-midnight boolean

cierre de sesión automático a medianoche

auto-sign-out-minutes
data.attributes.auto-sign-out-minutes string

auto-sign-out-minutes

city
data.attributes.city string

city

company-name-override
data.attributes.company-name-override string

company-name-override

disabled
data.attributes.disabled boolean

disabled

employees-csv-upload-status
data.attributes.employees-csv-upload-status string

employees-csv-upload-status

employees-sync-message
data.attributes.employees-sync-message string

employees-sync-message

fallback-notifications-enabled
data.attributes.fallback-notifications-enabled boolean

fallback-notifications-enabled

pre-registration-required-enabled
data.attributes.pre-registration-required-enabled boolean

pre-registration-required-enabled

latitude
data.attributes.latitude float

latitude

configuración regional
data.attributes.locale string

configuración regional

logo-small-url
data.attributes.logo-small-url string

logo-small-url

logo-thumb-url
data.attributes.logo-thumb-url string

logo-thumb-url

logo-url
data.attributes.logo-url string

logo-url

longitude
data.attributes.longitude float

longitude

nombre
data.attributes.name string

nombre

printer-notifications-enabled
data.attributes.printer-notifications-enabled boolean

printer-notifications-enabled

varios idiomas habilitados
data.attributes.multiple-languages-enabled boolean

varios idiomas habilitados

configuraciones regionales habilitadas
data.attributes.enabled-locales array of

configuraciones regionales habilitadas

estado
data.attributes.state string

estado

timezone
data.attributes.timezone string

timezone

archivo comprimido
data.attributes.zip string

archivo comprimido

promedio de visitantes mensuales
data.attributes.average-monthly-visitors float

promedio de visitantes mensuales

created-at
data.attributes.created-at string

created-at

last-entry-at
data.attributes.last-entry-at string

last-entry-at

updated-at
data.attributes.updated-at string

updated-at

propio
data.relationships.company.links.self string

propio

relacionado
data.relationships.company.links.related string

relacionado

propio
data.relationships.device-config.links.self string

propio

relacionado
data.relationships.device-config.links.related string

relacionado

propio
data.relationships.gdpr-configuration.links.self string

propio

relacionado
data.relationships.gdpr-configuration.links.related string

relacionado

propio
data.relationships.printer.links.self string

propio

relacionado
data.relationships.printer.links.related string

relacionado

propio
data.relationships.devices.links.self string

propio

relacionado
data.relationships.devices.links.related string

relacionado

propio
data.relationships.employees.links.self string

propio

relacionado
data.relationships.employees.links.related string

relacionado

propio
data.relationships.fallback-contacts.links.self string

propio

relacionado
data.relationships.fallback-contacts.links.related string

relacionado

propio
data.relationships.flows.links.self string

propio

relacionado
data.relationships.flows.links.related string

relacionado

propio
data.relationships.locations-setup-guide-steps.links.self string

propio

relacionado
data.relationships.locations-setup-guide-steps.links.related string

relacionado

propio
data.relationships.printers.links.self string

propio

relacionado
data.relationships.printers.links.related string

relacionado

propio
data.relationships.printer-contacts.links.self string

propio

relacionado
data.relationships.printer-contacts.links.related string

relacionado

total
meta.total integer

total

Primero
links.first string

Primero

último
links.last string

último

Obtener una entrada

Solicitud GET para recuperar información sobre una sola entrada.

Parámetros

Nombre Clave Requerido Tipo Description
entry_id
entry_id True string

entry_id

filter[location]
filter[location] integer

filter[location]

Aceptar
Accept string

Aceptar

Devoluciones

Nombre Ruta de acceso Tipo Description
id
data.id string

id

type
data.type string

type

nombre completo
data.attributes.full-name string

nombre completo

Correo electrónico
data.attributes.email string

Correo electrónico

host
data.attributes.host string

host

host-email
data.attributes.host-email string

host-email

notas privadas
data.attributes.private-notes string

notas privadas

signed-in-at
data.attributes.signed-in-at string

signed-in-at

device-session-uuid
data.attributes.device-session-uuid string

device-session-uuid

iniciar sesión a través
data.attributes.signed-in-via string

iniciar sesión a través

signed-in-by
data.attributes.signed-in-by string

signed-in-by

cerrar sesión mediante
data.attributes.signed-out-via string

cerrar sesión mediante

cerrar sesión
data.attributes.signed-out-by string

cerrar sesión

grande
data.attributes.thumbnails.large string

grande

pequeño
data.attributes.thumbnails.small string

pequeño

flow-name
data.attributes.flow-name string

flow-name

original-nda-sign-date
data.attributes.original-nda-sign-date string

original-nda-sign-date

id-check-status
data.attributes.id-check-status string

id-check-status

entrega de is-delivery
data.attributes.is-delivery boolean

entrega de is-delivery

acuerdo rechazado
data.attributes.agreement-refused boolean

acuerdo rechazado

pov-key
data.attributes.pov-key string

pov-key

datos de usuario
data.attributes.user-data array of object

datos de usuario

campo
data.attributes.user-data.field string

campo

value
data.attributes.user-data.value string

value

sms-status
data.attributes.sms-status string

sms-status

estado de aprobación
data.attributes.approval-status string

estado de aprobación

push-status
data.attributes.push-status string

push-status

email-status
data.attributes.email-status string

email-status

slack-status
data.attributes.slack-status string

slack-status

hipchat-status
data.attributes.hipchat-status string

hipchat-status

type
data.relationships.location.data.type string

type

id
data.relationships.location.data.id string

id

type
data.relationships.employee.data.type string

type

id
data.relationships.employee.data.id string

id

type
data.relationships.invite.data.type string

type

id
data.relationships.invite.data.id string

id

type
data.relationships.flow.data.type string

type

id
data.relationships.flow.data.id string

id

relacionado
data.relationships.previous-entries.links.related string

relacionado

relacionado
data.relationships.platform-jobs.links.related string

relacionado

propio
links.self string

propio

Obtener una invitación

Solicitud GET para recuperar información sobre una sola invitación.

Parámetros

Nombre Clave Requerido Tipo Description
invite_id
invite_id True string

invite_id

Aceptar
Accept string

Aceptar

Devoluciones

Nombre Ruta de acceso Tipo Description
id
data.id string

id

type
data.type string

type

nombre completo
data.attributes.full-name string

nombre completo

Correo electrónico
data.attributes.email string

Correo electrónico

inviter-name
data.attributes.inviter-name string

inviter-name

hora prevista de llegada
data.attributes.expected-arrival-time string

hora prevista de llegada

notas privadas
data.attributes.private-notes string

notas privadas

llegado
data.attributes.arrived boolean

llegado

been-here-before
data.attributes.been-here-before boolean

been-here-before

flow-name
data.attributes.flow-name string

flow-name

flow-id
data.attributes.flow-id integer

flow-id

datos de usuario
data.attributes.user-data array of object

datos de usuario

campo
data.attributes.user-data.field string

campo

value
data.attributes.user-data.value string

value

invitados adicionales
data.attributes.additional-guests integer

invitados adicionales

guest-updated-at
data.attributes.guest-updated-at string

guest-updated-at

Nda
data.attributes.nda string

Nda

Disponible en nda
data.attributes.nda-available boolean

Disponible en nda

original-nda-sign-date
data.attributes.original-nda-sign-date string

original-nda-sign-date

secret-token
data.attributes.secret-token string

secret-token

estado de aprobación
data.attributes.approval-status string

estado de aprobación

type
data.relationships.entry.data.type string

type

id
data.relationships.entry.data.id string

id

id
data.relationships.location.data.id string

id

type
data.relationships.location.data.type string

type

type
data.relationships.flow.data.type string

type

id
data.relationships.flow.data.id string

id

type
data.relationships.employee.data.type string

type

id
data.relationships.employee.data.id string

id

type
data.relationships.creator.data.type string

type

id
data.relationships.creator.data.id string

id

incluido
included array of object

incluido

id
included.id string

id

type
included.type string

type

nombre completo
included.attributes.full-name string

nombre completo

Correo electrónico
included.attributes.email string

Correo electrónico

número de teléfono
included.attributes.phone-number string

número de teléfono

avatar
included.attributes.avatar string

avatar

created-at
included.attributes.created-at string

created-at

habilitado para correo electrónico
included.attributes.email-enabled boolean

habilitado para correo electrónico

habilitado para sms
included.attributes.sms-enabled boolean

habilitado para sms

call-enabled
included.attributes.call-enabled string

call-enabled

habilitado para slack
included.attributes.slack-enabled boolean

habilitado para slack

hipchat habilitado
included.attributes.hipchat-enabled boolean

hipchat habilitado

habilitado para inserción
included.attributes.push-enabled boolean

habilitado para inserción

invite-push-enabled
included.attributes.invite-push-enabled boolean

invite-push-enabled

has-profile
included.attributes.has-profile boolean

has-profile

intercom-identity-hash
included.attributes.intercom-identity-hash string

intercom-identity-hash

relacionado
included.relationships.location-roles.links.related string

relacionado

relacionado
included.relationships.company-roles.links.related string

relacionado

datos
included.relationships.emails.data array of object

datos

type
included.relationships.emails.data.type string

type

id
included.relationships.emails.data.id string

id

propio
links.self string

propio

Desencadenadores

desencadenador de Invite-Created

Desencadene una acción en MS Flow cuando se cree una invitación de Envoy.

desencadenador de Invite-Created

Desencadene una acción en MS Flow cuando se cree una invitación de Envoy.

Parámetros

Nombre Clave Requerido Tipo Description
token
token string

token