Partilhar via

Enviado (Pré-visualização)

Um conector Envoy que permite que você possa conectar sua conta Envoy (nossos pontos de extremidade REST API) a quaisquer outros conectores. Um exemplo seria criar convites em massa no Envoy com detalhes de uma planilha do Microsoft Excel Online.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Equipe de Suporte do Enviado
URL https://envoy.help/
Email hi@envoy.com
Metadados do conector
Editora Enviado, Inc.
Sítio Web https://envoy.com/
Política de privacidade https://envoy.com/privacypolicy/
Categorias Business Intelligence; Dados

Na versão 2.0, você também pode usar a criação do Envoy Invite como um gatilho.

Pré-requisitos

Para usar esse conector, você precisará de uma conta Envoy com nome de usuário e senha. Para acionar a funcionalidade, você também precisará instalar o Envoy Integration "Microsoft Flow".

Como obter credenciais

Para se autenticar no Envoy, você precisará do seu nome de usuário e senha do Envoy.

Para acionar a funcionalidade, você precisará do Token de Instalação fornecido durante a Etapa 2 da configuração de integração do "Microsoft Flow" no Envoy.

Problemas conhecidos e limitações

Neste momento, o único gatilho disponível é a Criação de Convites. Esperamos adicionar mais gatilhos em um futuro próximo.

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:
Predefinição Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
nome de utilizador securestring O nome de usuário para esta api Verdade
palavra-passe securestring A senha para esta api Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Adicionar filtro de lista de bloqueio

Solicitação POST para adicionar um filtro de lista de bloqueio
Atualizar um convite

Solicitação PATCH para atualizar as informações de um convidado.
Criar convites

Esta é a solicitação POST para criar um convite
Obter filtros de lista de bloqueio

Solicitação GET para recuperar filtros de lista de bloqueios.
Obter fluxos

Solicitação GET para recuperar informações sobre os fluxos para sua localização.
Obter informações da empresa

Recuperar informações sobre a empresa (GET)
Obter lista de funcionários

Solicitação GET para recuperar a lista de funcionários
Obter localizações

Solicitação GET para recuperar locais
Obter uma entrada

Solicitação GET para recuperar informações sobre uma única entrada.
Receba convites

Solicitação GET para recuperar informações de convite com base na filtragem.
Receba um convite

Solicitação GET para recuperar informações sobre um único convite.

Adicionar filtro de lista de bloqueio

ID da Operação:
addBlockListFilter

Solicitação POST para adicionar um filtro de lista de bloqueio

Parâmetros

Name Chave Necessário Tipo Description
aliases
 aliases array of

aliases
descrição
 description string

descrição
E-mails
 emails array of string

E-mails
nome-completo
 full-name string

nome-completo
palavra-chave
 keyword string

palavra-chave
outras palavras-chave
 other-keywords array of

outras palavras-chave
razão
 reason string

razão
Números de telefone
 phone-numbers array of

Números de telefone
tipo
 type string

tipo
id
 id string

ID (localização)
tipo
 type string

tipo

Devoluções

Name Caminho Tipo Description
id
 data.id string

id
tipo
 data.type string

tipo
Eu mesmo
 data.links.self string

Eu mesmo
aliases
 data.attributes.aliases array of

aliases
descrição
 data.attributes.description string

descrição
E-mails
 data.attributes.emails array of string

E-mails
nome-completo
 data.attributes.full-name string

nome-completo
palavra-chave
 data.attributes.keyword string

palavra-chave
outras palavras-chave
 data.attributes.other-keywords array of

outras palavras-chave
Números de telefone
 data.attributes.phone-numbers array of

Números de telefone
Original
 data.attributes.photo.original string

Original
polegar
 data.attributes.photo.thumb string

polegar
razão
 data.attributes.reason string

razão
criado por
 data.attributes.created-by string

criado por
Eu mesmo
 data.relationships.location.links.self string

Eu mesmo
relacionados
 data.relationships.location.links.related string

relacionados
Eu mesmo
 data.relationships.user.links.self string

Eu mesmo
relacionados
 data.relationships.user.links.related string

relacionados

Atualizar um convite

ID da Operação:
updateInvite

Solicitação PATCH para atualizar as informações de um convidado.

Parâmetros

Name Chave Necessário Tipo Description
invite_id
 invite_id True string

invite_id
Tipo de conteúdo
 Content-Type string

Tipo de conteúdo
id
 id string

id
nome-completo
 full-name string

nome-completo
e-mail
 email string

e-mail
inviter-name
 inviter-name string

inviter-name
Hora prevista de chegada
 expected-arrival-time string

tempo previsto de chegada (Formato esperado: 2019-03-24T21:15:00.000Z)
regra recorrente
 recurring-rule string

regra recorrente
rrule-até
 rrule-until string

rrule-até
notas privadas
 private-notes string

notas privadas
foi-aqui-antes
 been-here-before boolean

foi-aqui-antes
Adicionais-Hóspedes
 additional-guests integer

Adicionais-Hóspedes
ignorar-notificação de convidado
 skip-guest-notification boolean

ignorar-notificação de convidado
NDA
 nda string

NDA
guest-atualizado-at
 guest-updated-at string

guest-updated-at (Formatação: 2019-03-24T21:15:00.000Z)
original-nda-data-sinal
 original-nda-sign-date string

original-nda-data-sinal
nda-disponível
 nda-available boolean

nda-disponível
nome-fluxo
 flow-name string

nome-fluxo
chegou
 arrived boolean

chegou
Estado-Aprovação
 approval-status string

Estado-Aprovação
campo
 field string

campo
valor
 value string

valor
tipo
 type string

tipo
id
 id string

id
tipo
 type string

tipo
id
 id string

ID (funcionário)
tipo
 type string

tipo
id
 id string

ID (localização)
tipo
 type string

tipo

Devoluções

Name Caminho Tipo Description
id
 data.id string

id
tipo
 data.type string

tipo
acordos-estatuto
 data.attributes.agreements-status string

acordos-estatuto
nome-completo
 data.attributes.full-name string

nome-completo
e-mail
 data.attributes.email string

e-mail
inviter-name
 data.attributes.inviter-name string

inviter-name
inviter-e-mail
 data.attributes.inviter-email string

inviter-e-mail
Hora prevista de chegada
 data.attributes.expected-arrival-time string

Hora prevista de chegada
notas privadas
 data.attributes.private-notes string

notas privadas
chegou
 data.attributes.arrived boolean

chegou
foi-aqui-antes
 data.attributes.been-here-before boolean

foi-aqui-antes
nome-fluxo
 data.attributes.flow-name string

nome-fluxo
fluxo-id
 data.attributes.flow-id integer

fluxo-id
dados do utilizador
 data.attributes.user-data array of object

dados do utilizador
campo
 data.attributes.user-data.field string

campo
valor
 data.attributes.user-data.value string

valor
Adicionais-Hóspedes
 data.attributes.additional-guests integer

Adicionais-Hóspedes
guest-atualizado-at
 data.attributes.guest-updated-at string

guest-atualizado-at
NDA
 data.attributes.nda string

NDA
nda-disponível
 data.attributes.nda-available boolean

nda-disponível
original-nda-data-sinal
 data.attributes.original-nda-sign-date string

original-nda-data-sinal
token-secreto
 data.attributes.secret-token string

token-secreto
nome do grupo
 data.attributes.group-name string

nome do grupo
foto-url
 data.attributes.photo-url string

foto-url
Código QR
 data.attributes.qr-code string

Código QR
qr-código-enviado-at
 data.attributes.qr-code-sent-at string

qr-código-enviado-at
pré-inscrição-completa
 data.attributes.preregistration-complete string

pré-inscrição-completa
estado
 data.attributes.approval-status.status string

estado
auto-aprovado
 data.attributes.approval-status.auto-approved boolean

auto-aprovado
relatório
 data.attributes.approval-status.report array of object

relatório
Resultado
 data.attributes.approval-status.report.result string

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

origem
lista negraReportUUID
 data.attributes.approval-status.report.blacklistReportUUID string

lista negraReportUUID
razão
 data.attributes.approval-status.report.reason string

razão
enviar SMS
 data.attributes.approval-status.report.messages.failure.text string

enviar SMS
cabeçalho
 data.attributes.approval-status.report.messages.failure.header string

cabeçalho
ID do revisor
 data.attributes.approval-status.reviewer-id string

ID do revisor
nome do revisor
 data.attributes.approval-status.reviewer-name string

nome do revisor
Nota de revisão
 data.attributes.approval-status.review-note string

Nota de revisão
revisado-em
 data.attributes.approval-status.reviewed-at string

revisado-em
tipo
 data.relationships.entry.data.type string

tipo
id
 data.relationships.entry.data.id string

id
id
 data.relationships.location.data.id string

id
tipo
 data.relationships.location.data.type string

tipo
tipo
 data.relationships.flow.data.type string

tipo
id
 data.relationships.flow.data.id string

id
tipo
 data.relationships.employee.data.type string

tipo
id
 data.relationships.employee.data.id string

id
tipo
 data.relationships.creator.data.type string

tipo
id
 data.relationships.creator.data.id string

id
relacionados
 data.relationships.platform-jobs.links.related string

relacionados
incluído
 included array of object

incluído
id
 included.id string

id
tipo
 included.type string

tipo
nome
 included.attributes.name string

nome
Eu mesmo
 links.self string

Eu mesmo

Criar convites

ID da Operação:
addInvite

Esta é a solicitação POST para criar um convite

Parâmetros

Name Chave Necessário Tipo Description
Tipo de conteúdo
 Content-Type string

Tipo de conteúdo
nome-completo
 full-name string

nome-completo
e-mail
 email string

e-mail
inviter-name
 inviter-name string

inviter-name
Hora prevista de chegada
 expected-arrival-time string

Hora prevista de chegada
regra recorrente
 recurring-rule string

regra recorrente
rrule-até
 rrule-until string

rrule-até
notas privadas
 private-notes string

notas privadas
foi-aqui-antes
 been-here-before boolean

foi-aqui-antes
Adicionais-Hóspedes
 additional-guests integer

Adicionais-Hóspedes
ignorar-notificação de convidado
 skip-guest-notification boolean

ignorar-notificação de convidado
acordos-estatuto
 agreements-status string

acordos-estatuto
local-ID
 place-id string

local-ID
nome-fluxo
 flow-name string

nome-fluxo
nome do grupo
 group-name string

nome do grupo
chegou
 arrived boolean

chegou
Estado-Aprovação
 approval-status string

Estado-Aprovação
campo
 field string

campo
valor
 value string

valor
tipo
 type string

tipo
id
 id string

ID (funcionário)
tipo
 type string

tipo
id
 id string

ID (localização)
tipo
 type string

tipo

Devoluções

Name Caminho Tipo Description
id
 data.id string

id
tipo
 data.type string

tipo
Eu mesmo
 data.links.self string

Eu mesmo
Adicionais-Hóspedes
 data.attributes.additional-guests integer

Adicionais-Hóspedes
estado
 data.attributes.approval-status.status string

estado
auto_approved
 data.attributes.approval-status.auto_approved boolean

auto_approved
relatório
 data.attributes.approval-status.report array of object

relatório
Resultado
 data.attributes.approval-status.report.result string

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

origem
lista negraReportUUID
 data.attributes.approval-status.report.blacklistReportUUID string

lista negraReportUUID
razão
 data.attributes.approval-status.report.reason string

razão
enviar SMS
 data.attributes.approval-status.report.messages.failure.text string

enviar SMS
cabeçalho
 data.attributes.approval-status.report.messages.failure.header string

cabeçalho
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
e-mail
 data.attributes.email string

e-mail
Hora prevista de chegada
 data.attributes.expected-arrival-time string

Hora prevista de chegada
hora prevista de partida
 data.attributes.expected-departure-time string

hora prevista de partida
nome-completo
 data.attributes.full-name string

nome-completo
guest-atualizado-at
 data.attributes.guest-updated-at string

guest-atualizado-at
é-pré-assinado
 data.attributes.is-presigned boolean

é-pré-assinado
address
 data.attributes.location-info.address string

address
id
 data.attributes.location-info.id integer

id
nome
 data.attributes.location-info.name string

nome
logo_url
 data.attributes.location-info.logo_url string

logo_url
notas privadas
 data.attributes.private-notes string

notas privadas
dados do utilizador
 data.attributes.user-data array of object

dados do utilizador
data.attributes.user-data.field string

campo
data.attributes.user-data.value string

valor
notificar-visitante
 data.attributes.notify-visitor boolean

notificar-visitante
criado-a partir de
 data.attributes.created-from string

criado-a partir de
chegou
 data.attributes.arrived boolean

chegou
touchless-login-on-available-time
 data.attributes.touchless-sign-in-available-time string

touchless-login-on-available-time
touchless-login-in-presence-required
 data.attributes.touchless-sign-in-presence-required boolean

touchless-login-in-presence-required
entry-signed-out-at
 data.attributes.entry-signed-out-at string

entry-signed-out-at
link pré-registo
 data.attributes.preregistration-link string

link pré-registo
criado-AT
 data.attributes.created-at string

criado-AT
atualizado-em
 data.attributes.updated-at string

atualizado-em
Eu mesmo
 data.relationships.attendee.links.self string

Eu mesmo
relacionados
 data.relationships.attendee.links.related string

relacionados
Eu mesmo
 data.relationships.creator.links.self string

Eu mesmo
relacionados
 data.relationships.creator.links.related string

relacionados
Eu mesmo
 data.relationships.employee.links.self string

Eu mesmo
relacionados
 data.relationships.employee.links.related string

relacionados
tipo
 data.relationships.employee.data.type string

tipo
id
 data.relationships.employee.data.id string

id
Eu mesmo
 data.relationships.entry.links.self string

Eu mesmo
relacionados
 data.relationships.entry.links.related string

relacionados
tipo
 data.relationships.entry.data.type object

tipo
id
 data.relationships.entry.data.id string

id
Eu mesmo
 data.relationships.flow.links.self string

Eu mesmo
relacionados
 data.relationships.flow.links.related string

relacionados
tipo
 data.relationships.flow.data.type string

tipo
id
 data.relationships.flow.data.id string

id
Eu mesmo
 data.relationships.location.links.self string

Eu mesmo
relacionados
 data.relationships.location.links.related string

relacionados
tipo
 data.relationships.location.data.type string

tipo
id
 data.relationships.location.data.id string

id
Eu mesmo
 data.relationships.platform-jobs.links.self string

Eu mesmo
relacionados
 data.relationships.platform-jobs.links.related string

relacionados

Obter filtros de lista de bloqueio

ID da Operação:
getblockListFilters

Solicitação GET para recuperar filtros de lista de bloqueios.

Parâmetros

Name Chave Necessário Tipo Description
filtrar[empresa]
 filter[company] integer

filtrar[empresa]
Tipo de conteúdo
 Content-Type string

Tipo de conteúdo

Devoluções

Name Caminho Tipo Description
dados
 data array of object

dados
id
 data.id string

id
tipo
 data.type string

tipo
Eu mesmo
 data.links.self string

Eu mesmo
aliases
 data.attributes.aliases array of

aliases
descrição
 data.attributes.description string

descrição
E-mails
 data.attributes.emails array of string

E-mails
nome-completo
 data.attributes.full-name string

nome-completo
palavra-chave
 data.attributes.keyword string

palavra-chave
outras palavras-chave
 data.attributes.other-keywords array of string

outras palavras-chave
Números de telefone
 data.attributes.phone-numbers array of

Números de telefone
Original
 data.attributes.photo.original string

Original
polegar
 data.attributes.photo.thumb string

polegar
razão
 data.attributes.reason string

razão
imagem-url
 data.attributes.image-url string

imagem-url
identificação externa
 data.attributes.external-id string

identificação externa
criado por
 data.attributes.created-by string

criado por
Eu mesmo
 data.relationships.location.links.self string

Eu mesmo
relacionados
 data.relationships.location.links.related string

relacionados
Eu mesmo
 data.relationships.user.links.self string

Eu mesmo
relacionados
 data.relationships.user.links.related string

relacionados
total
 meta.total integer

total

Obter fluxos

ID da Operação:
getFlowsInfo

Solicitação GET para recuperar informações sobre os fluxos para sua localização.

Parâmetros

Name Chave Necessário Tipo Description
filtrar[localização]
 filter[location] integer

filtrar[localização]

Devoluções

Name Caminho Tipo Description
dados
 data array of object

dados
id
 data.id string

id
tipo
 data.type string

tipo
Eu mesmo
 data.links.self string

Eu mesmo
Adicionais-Hóspedes
 data.attributes.additional-guests boolean

Adicionais-Hóspedes
minutos de saída automática
 data.attributes.auto-sign-out-minutes string

minutos de saída automática
sair automaticamente à meia-noite
 data.attributes.auto-sign-out-at-midnight boolean

sair automaticamente à meia-noite
habilitado para crachá
 data.attributes.badge-enabled boolean

habilitado para crachá
enabled
 data.attributes.enabled boolean

enabled
Verificação de ID
 data.attributes.id-check boolean

Verificação de ID
Nomes localizados no iPad
 data.attributes.ipad-localized-names array of object

Nomes localizados no iPad
idioma-código
 data.attributes.ipad-localized-names.language-code string

idioma-código
Código da região
 data.attributes.ipad-localized-names.region-code string

Código da região
nome de exibição
 data.attributes.ipad-localized-names.display-name string

nome de exibição
nome
 data.attributes.name string

nome
posição
 data.attributes.position integer

posição
use-existing-photo
 data.attributes.use-existing-photo boolean

use-existing-photo
criado-AT
 data.attributes.created-at string

criado-AT
atualizado-em
 data.attributes.updated-at string

atualizado-em
Eu mesmo
 data.relationships.agreement-page.links.self string

Eu mesmo
relacionados
 data.relationships.agreement-page.links.related string

relacionados
Eu mesmo
 data.relationships.badge.links.self string

Eu mesmo
relacionados
 data.relationships.badge.links.related string

relacionados
Eu mesmo
 data.relationships.location.links.self string

Eu mesmo
relacionados
 data.relationships.location.links.related string

relacionados
Eu mesmo
 data.relationships.photo-page.links.self string

Eu mesmo
relacionados
 data.relationships.photo-page.links.related string

relacionados
Eu mesmo
 data.relationships.sign-in-field-page.links.self string

Eu mesmo
relacionados
 data.relationships.sign-in-field-page.links.related string

relacionados
Eu mesmo
 data.relationships.summary-page.links.self string

Eu mesmo
relacionados
 data.relationships.summary-page.links.related string

relacionados
total
 meta.total integer

total
primeiro
 links.first string

primeiro
último
 links.last string

último

Obter informações da empresa

ID da Operação:
getCompanyInfo

Recuperar informações sobre a empresa (GET)

Parâmetros

Name Chave Necessário Tipo Description
Aceitar
 Accept string

Aceitar

Devoluções

Name Caminho Tipo Description
total
 meta.total integer

total
limit
 meta.limit integer

limit
offset
 meta.offset integer

offset
dados
 data array of object

dados
id
 data.id string

id
tipo
 data.type string

tipo
nome
 data.attributes.name string

nome
planear-intenção
 data.attributes.plan-intent string

planear-intenção
intenção de compra
 data.attributes.buy-intent boolean

intenção de compra
habilitado para chamada
 data.attributes.call-enabled boolean

habilitado para chamada
Compatível com AppleTV
 data.attributes.appletv-enabled boolean

Compatível com AppleTV
Conectado a SAML
 data.attributes.saml-connected boolean

Conectado a SAML
active
 data.attributes.active boolean

active
funcionários-sync-state
 data.attributes.employees-sync-state string

funcionários-sync-state
funcionários-sync-provider
 data.attributes.employees-sync-provider string

funcionários-sync-provider
funcionários-last-sync-at
 data.attributes.employees-last-sync-at string

funcionários-last-sync-at
criado-AT
 data.attributes.created-at string

criado-AT
atualizado-em
 data.attributes.updated-at string

atualizado-em
estado de integração
 data.attributes.onboarding-status string

estado de integração
onboarding-locations-count
 data.attributes.onboarding-locations-count string

onboarding-locations-count
é-beta
 data.attributes.is-beta boolean

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

adhoc-plugins
localização em cache-quantidade-quantidade
 data.attributes.cached-locations-quantity integer

localização em cache-quantidade-quantidade
tipo
 data.relationships.subscription.data.type string

tipo
id
 data.relationships.subscription.data.id string

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

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

id
dados
 data.relationships.contracts.data array of object

dados
tipo
 data.relationships.contracts.data.type string

tipo
id
 data.relationships.contracts.data.id string

id
dados
 data.relationships.administrators.data array of object

dados
tipo
 data.relationships.administrators.data.type string

tipo
id
 data.relationships.administrators.data.id string

id
dados
 data.relationships.locations.data array of object

dados
tipo
 data.relationships.locations.data.type string

tipo
id
 data.relationships.locations.data.id string

id
tipo
 data.relationships.saml.data.type string

tipo
id
 data.relationships.saml.data.id string

id
Eu mesmo
 links.self string

Eu mesmo
primeiro
 links.first string

primeiro
último
 links.last string

último

Obter lista de funcionários

ID da Operação:
getEmployee

Solicitação GET para recuperar a lista de funcionários

Devoluções

Name Caminho Tipo Description
dados
 data array of object

dados
id
 data.id string

id
tipo
 data.type string

tipo
Eu mesmo
 data.links.self string

Eu mesmo
cc-empregado
 data.attributes.cc-employee boolean

cc-empregado
ID da empresa
 data.attributes.company-id integer

ID da empresa
Suprimido
 data.attributes.deleted boolean

Suprimido
não sincronizar
 data.attributes.do-not-sync boolean

não sincronizar
e-mail
 data.attributes.email string

e-mail
ocultar-de-host-list
 data.attributes.hide-from-host-list boolean

ocultar-de-host-list
adicionado manualmente
 data.attributes.manually-added boolean

adicionado manualmente
manualmente-adicionado-local-presente
 data.attributes.manually-added-location-present boolean

manualmente-adicionado-local-presente
nome
 data.attributes.name string

nome
número de telefone
 data.attributes.phone-number string

número de telefone
criado-AT
 data.attributes.created-at string

criado-AT
suprimido-em
 data.attributes.deleted-at string

suprimido-em
atualizado-em
 data.attributes.updated-at string

atualizado-em
Eu mesmo
 data.relationships.company.links.self string

Eu mesmo
relacionados
 data.relationships.company.links.related string

relacionados
Eu mesmo
 data.relationships.user.links.self string

Eu mesmo
relacionados
 data.relationships.user.links.related string

relacionados
Eu mesmo
 data.relationships.assistants.links.self string

Eu mesmo
relacionados
 data.relationships.assistants.links.related string

relacionados
Eu mesmo
 data.relationships.bosses.links.self string

Eu mesmo
relacionados
 data.relationships.bosses.links.related string

relacionados
Eu mesmo
 data.relationships.employee-locations.links.self string

Eu mesmo
relacionados
 data.relationships.employee-locations.links.related string

relacionados
Eu mesmo
 data.relationships.locations.links.self string

Eu mesmo
relacionados
 data.relationships.locations.links.related string

relacionados
total
 meta.total integer

total
primeiro
 links.first string

primeiro
último
 links.last string

último

Obter localizações

ID da Operação:
getLocationInfo

Solicitação GET para recuperar locais

Parâmetros

Name Chave Necessário Tipo Description
Aceitar
 Accept string

Aceitar

Devoluções

Name Caminho Tipo Description
dados
 data array of object

dados
id
 data.id string

id
tipo
 data.type string

tipo
Eu mesmo
 data.links.self string

Eu mesmo
address
 data.attributes.address string

address
endereço-linha-um
 data.attributes.address-line-one string

endereço-linha-um
endereço-linha-dois
 data.attributes.address-line-two string

endereço-linha-dois
sair automaticamente à meia-noite
 data.attributes.auto-sign-out-at-midnight boolean

sair automaticamente à meia-noite
minutos de saída automática
 data.attributes.auto-sign-out-minutes string

minutos de saída automática
city
 data.attributes.city string

city
substituição do nome da empresa
 data.attributes.company-name-override string

substituição do nome da empresa
desactivado
 data.attributes.disabled boolean

desactivado
funcionários-csv-upload-status
 data.attributes.employees-csv-upload-status string

funcionários-csv-upload-status
funcionários-sync-mensagem
 data.attributes.employees-sync-message string

funcionários-sync-mensagem
Notificações de fallback habilitadas
 data.attributes.fallback-notifications-enabled boolean

Notificações de fallback habilitadas
pré-registo-obrigatório-ativado
 data.attributes.pre-registration-required-enabled boolean

pré-registo-obrigatório-ativado
latitude
 data.attributes.latitude float

latitude
região
 data.attributes.locale string

região
logo-pequeno-url
 data.attributes.logo-small-url string

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

logo-polegar-url
logotipo-url
 data.attributes.logo-url string

logotipo-url
longitude
 data.attributes.longitude float

longitude
nome
 data.attributes.name string

nome
impressora-notificações-ativado
 data.attributes.printer-notifications-enabled boolean

impressora-notificações-ativado
habilitado para vários idiomas
 data.attributes.multiple-languages-enabled boolean

habilitado para vários idiomas
Localidades habilitadas
 data.attributes.enabled-locales array of

Localidades habilitadas
state
 data.attributes.state string

state
timezone
 data.attributes.timezone string

timezone
ZIP
 data.attributes.zip string

ZIP
média de visitantes mensais
 data.attributes.average-monthly-visitors float

média de visitantes mensais
criado-AT
 data.attributes.created-at string

criado-AT
última entrada-em
 data.attributes.last-entry-at string

última entrada-em
atualizado-em
 data.attributes.updated-at string

atualizado-em
Eu mesmo
 data.relationships.company.links.self string

Eu mesmo
relacionados
 data.relationships.company.links.related string

relacionados
Eu mesmo
 data.relationships.device-config.links.self string

Eu mesmo
relacionados
 data.relationships.device-config.links.related string

relacionados
Eu mesmo
 data.relationships.gdpr-configuration.links.self string

Eu mesmo
relacionados
 data.relationships.gdpr-configuration.links.related string

relacionados
Eu mesmo
 data.relationships.printer.links.self string

Eu mesmo
relacionados
 data.relationships.printer.links.related string

relacionados
Eu mesmo
 data.relationships.devices.links.self string

Eu mesmo
relacionados
 data.relationships.devices.links.related string

relacionados
Eu mesmo
 data.relationships.employees.links.self string

Eu mesmo
relacionados
 data.relationships.employees.links.related string

relacionados
Eu mesmo
 data.relationships.fallback-contacts.links.self string

Eu mesmo
relacionados
 data.relationships.fallback-contacts.links.related string

relacionados
Eu mesmo
 data.relationships.flows.links.self string

Eu mesmo
relacionados
 data.relationships.flows.links.related string

relacionados
Eu mesmo
 data.relationships.locations-setup-guide-steps.links.self string

Eu mesmo
relacionados
 data.relationships.locations-setup-guide-steps.links.related string

relacionados
Eu mesmo
 data.relationships.printers.links.self string

Eu mesmo
relacionados
 data.relationships.printers.links.related string

relacionados
Eu mesmo
 data.relationships.printer-contacts.links.self string

Eu mesmo
relacionados
 data.relationships.printer-contacts.links.related string

relacionados
total
 meta.total integer

total
primeiro
 links.first string

primeiro
último
 links.last string

último

Obter uma entrada

ID da Operação:
getEntryInfoByID

Solicitação GET para recuperar informações sobre uma única entrada.

Parâmetros

Name Chave Necessário Tipo Description
entry_id
 entry_id True string

entry_id
filtrar[localização]
 filter[location] integer

filtrar[localização]
Aceitar
 Accept string

Aceitar

Devoluções

Name Caminho Tipo Description
id
 data.id string

id
tipo
 data.type string

tipo
nome-completo
 data.attributes.full-name string

nome-completo
e-mail
 data.attributes.email string

e-mail
alojar
 data.attributes.host string

alojar
e-mail do anfitrião
 data.attributes.host-email string

e-mail do anfitrião
notas privadas
 data.attributes.private-notes string

notas privadas
assinado-in-at
 data.attributes.signed-in-at string

assinado-in-at
dispositivo-sessão-uuid
 data.attributes.device-session-uuid string

dispositivo-sessão-uuid
via conectada
 data.attributes.signed-in-via string

via conectada
assinado-in-by
 data.attributes.signed-in-by string

assinado-in-by
desconectado-via
 data.attributes.signed-out-via string

desconectado-via
assinado por
 data.attributes.signed-out-by string

assinado por
grande
 data.attributes.thumbnails.large string

grande
pequeno
 data.attributes.thumbnails.small string

pequeno
nome-fluxo
 data.attributes.flow-name string

nome-fluxo
original-nda-data-sinal
 data.attributes.original-nda-sign-date string

original-nda-data-sinal
id-check-status
 data.attributes.id-check-status string

id-check-status
is-entrega
 data.attributes.is-delivery boolean

is-entrega
acordo-recusado
 data.attributes.agreement-refused boolean

acordo-recusado
POV-Chave
 data.attributes.pov-key string

POV-Chave
dados do utilizador
 data.attributes.user-data array of object

dados do utilizador
campo
 data.attributes.user-data.field string

campo
valor
 data.attributes.user-data.value string

valor
SMS-Status
 data.attributes.sms-status string

SMS-Status
Estado-Aprovação
 data.attributes.approval-status string

Estado-Aprovação
push-status
 data.attributes.push-status string

push-status
status do e-mail
 data.attributes.email-status string

status do e-mail
status de folga
 data.attributes.slack-status string

status de folga
status hipchat
 data.attributes.hipchat-status string

status hipchat
tipo
 data.relationships.location.data.type string

tipo
id
 data.relationships.location.data.id string

id
tipo
 data.relationships.employee.data.type string

tipo
id
 data.relationships.employee.data.id string

id
tipo
 data.relationships.invite.data.type string

tipo
id
 data.relationships.invite.data.id string

id
tipo
 data.relationships.flow.data.type string

tipo
id
 data.relationships.flow.data.id string

id
relacionados
 data.relationships.previous-entries.links.related string

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

relacionados
Eu mesmo
 links.self string

Eu mesmo

Receba convites

ID da Operação:
getInviteInfo

Solicitação GET para recuperar informações de convite com base na filtragem.

Parâmetros

Name Chave Necessário Tipo Description
filtrar[localização]
 filter[location] integer

filtrar[localização]
filtrar[data]
 filter[date] string

filtrar[data]
Aceitar
 Accept string

Aceitar

Devoluções

Name Caminho Tipo Description
dados
 data array of object

dados
id
 data.id string

id
tipo
 data.type string

tipo
Eu mesmo
 data.links.self string

Eu mesmo
Adicionais-Hóspedes
 data.attributes.additional-guests integer

Adicionais-Hóspedes
estado
 data.attributes.approval-status.status string

estado
auto_approved
 data.attributes.approval-status.auto_approved boolean

auto_approved
relatório
 data.attributes.approval-status.report array of object

relatório
Resultado
 data.attributes.approval-status.report.result string

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

origem
lista negraReportUUID
 data.attributes.approval-status.report.blacklistReportUUID string

lista negraReportUUID
razão
 data.attributes.approval-status.report.reason string

razão
enviar SMS
 data.attributes.approval-status.report.messages.failure.text string

enviar SMS
cabeçalho
 data.attributes.approval-status.report.messages.failure.header string

cabeçalho
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
e-mail
 data.attributes.email string

e-mail
Hora prevista de chegada
 data.attributes.expected-arrival-time string

Hora prevista de chegada
hora prevista de partida
 data.attributes.expected-departure-time string

hora prevista de partida
nome-completo
 data.attributes.full-name string

nome-completo
guest-atualizado-at
 data.attributes.guest-updated-at string

guest-atualizado-at
é-pré-assinado
 data.attributes.is-presigned boolean

é-pré-assinado
address
 data.attributes.location-info.address string

address
id
 data.attributes.location-info.id integer

id
nome
 data.attributes.location-info.name string

nome
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
dados do utilizador
 data.attributes.user-data array of object

dados do utilizador
campo
 data.attributes.user-data.field string

campo
valor
 data.attributes.user-data.value string

valor
notificar-visitante
 data.attributes.notify-visitor boolean

notificar-visitante
criado-a partir de
 data.attributes.created-from string

criado-a partir de
place_id
 data.attributes.locality.place_id string

place_id
local-ID
 data.attributes.locality.place-id string

local-ID
chegou
 data.attributes.arrived boolean

chegou
touchless-login-on-available-time
 data.attributes.touchless-sign-in-available-time string

touchless-login-on-available-time
touchless-login-in-presence-required
 data.attributes.touchless-sign-in-presence-required boolean

touchless-login-in-presence-required
entry-signed-out-at
 data.attributes.entry-signed-out-at string

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

atestado
phone
 data.attributes.phone string

phone
link pré-registo
 data.attributes.preregistration-link string

link pré-registo
pré-registo-status-link
 data.attributes.preregistration-status-link string

pré-registo-status-link
lembrete-enviado-em
 data.attributes.reminder-sent-at string

lembrete-enviado-em
criado-AT
 data.attributes.created-at string

criado-AT
atualizado-em
 data.attributes.updated-at string

atualizado-em
Eu mesmo
 data.relationships.attendee.links.self string

Eu mesmo
relacionados
 data.relationships.attendee.links.related string

relacionados
Eu mesmo
 data.relationships.creator.links.self string

Eu mesmo
relacionados
 data.relationships.creator.links.related string

relacionados
Eu mesmo
 data.relationships.employee.links.self string

Eu mesmo
relacionados
 data.relationships.employee.links.related string

relacionados
tipo
 data.relationships.employee.data.type string

tipo
id
 data.relationships.employee.data.id string

id
Eu mesmo
 data.relationships.entry.links.self string

Eu mesmo
relacionados
 data.relationships.entry.links.related string

relacionados
tipo
 data.relationships.entry.data.type string

tipo
id
 data.relationships.entry.data.id string

id
Eu mesmo
 data.relationships.flow.links.self string

Eu mesmo
relacionados
 data.relationships.flow.links.related string

relacionados
tipo
 data.relationships.flow.data.type string

tipo
id
 data.relationships.flow.data.id string

id
Eu mesmo
 data.relationships.location.links.self string

Eu mesmo
relacionados
 data.relationships.location.links.related string

relacionados
tipo
 data.relationships.location.data.type string

tipo
id
 data.relationships.location.data.id string

id
Eu mesmo
 data.relationships.platform-jobs.links.self string

Eu mesmo
relacionados
 data.relationships.platform-jobs.links.related string

relacionados
total
 meta.total integer

total
primeiro
 links.first string

primeiro
next
 links.next string

next
último
 links.last string

último

Receba um convite

ID da Operação:
getInviteByID

Solicitação GET para recuperar informações sobre um único convite.

Parâmetros

Name Chave Necessário Tipo Description
invite_id
 invite_id True string

invite_id
Aceitar
 Accept string

Aceitar

Devoluções

Name Caminho Tipo Description
id
 data.id string

id
tipo
 data.type string

tipo
nome-completo
 data.attributes.full-name string

nome-completo
e-mail
 data.attributes.email string

e-mail
inviter-name
 data.attributes.inviter-name string

inviter-name
Hora prevista de chegada
 data.attributes.expected-arrival-time string

Hora prevista de chegada
notas privadas
 data.attributes.private-notes string

notas privadas
chegou
 data.attributes.arrived boolean

chegou
foi-aqui-antes
 data.attributes.been-here-before boolean

foi-aqui-antes
nome-fluxo
 data.attributes.flow-name string

nome-fluxo
fluxo-id
 data.attributes.flow-id integer

fluxo-id
dados do utilizador
 data.attributes.user-data array of object

dados do utilizador
campo
 data.attributes.user-data.field string

campo
valor
 data.attributes.user-data.value string

valor
Adicionais-Hóspedes
 data.attributes.additional-guests integer

Adicionais-Hóspedes
guest-atualizado-at
 data.attributes.guest-updated-at string

guest-atualizado-at
NDA
 data.attributes.nda string

NDA
nda-disponível
 data.attributes.nda-available boolean

nda-disponível
original-nda-data-sinal
 data.attributes.original-nda-sign-date string

original-nda-data-sinal
token-secreto
 data.attributes.secret-token string

token-secreto
Estado-Aprovação
 data.attributes.approval-status string

Estado-Aprovação
tipo
 data.relationships.entry.data.type string

tipo
id
 data.relationships.entry.data.id string

id
id
 data.relationships.location.data.id string

id
tipo
 data.relationships.location.data.type string

tipo
tipo
 data.relationships.flow.data.type string

tipo
id
 data.relationships.flow.data.id string

id
tipo
 data.relationships.employee.data.type string

tipo
id
 data.relationships.employee.data.id string

id
tipo
 data.relationships.creator.data.type string

tipo
id
 data.relationships.creator.data.id string

id
incluído
 included array of object

incluído
id
 included.id string

id
tipo
 included.type string

tipo
nome-completo
 included.attributes.full-name string

nome-completo
e-mail
 included.attributes.email string

e-mail
número de telefone
 included.attributes.phone-number string

número de telefone
Avatar
 included.attributes.avatar string

Avatar
criado-AT
 included.attributes.created-at string

criado-AT
Habilitado para e-mail
 included.attributes.email-enabled boolean

Habilitado para e-mail
Habilitado para SMS
 included.attributes.sms-enabled boolean

Habilitado para SMS
habilitado para chamada
 included.attributes.call-enabled string

habilitado para chamada
habilitado para folga
 included.attributes.slack-enabled boolean

habilitado para folga
habilitado para hipchat
 included.attributes.hipchat-enabled boolean

habilitado para hipchat
Habilitado para push
 included.attributes.push-enabled boolean

Habilitado para push
habilitado para convite-push
 included.attributes.invite-push-enabled boolean

habilitado para convite-push
tem perfil
 included.attributes.has-profile boolean

tem perfil
interfone-identidade-hash
 included.attributes.intercom-identity-hash string

interfone-identidade-hash
relacionados
 included.relationships.location-roles.links.related string

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

relacionados
dados
 included.relationships.emails.data array of object

dados
tipo
 included.relationships.emails.data.type string

tipo
id
 included.relationships.emails.data.id string

id
Eu mesmo
 links.self string

Eu mesmo

Acionadores

Invite-Created Gatilho

Acione uma ação no MS Flow quando um Convite de Enviado for criado.

Invite-Created Gatilho

ID da Operação:
InviteCreated

Acione uma ação no MS Flow quando um Convite de Enviado for criado.

Parâmetros

Name Chave Necessário Tipo Description
token
 token string

token