Givebutter (Independent Publisher) (versão prévia)
A Givebutter é a primeira plataforma de arrecadação de fundos de ponta a ponta completamente gratuita do mundo. Crie mais com formas modernas, campanhas e eventos. Gerencie seus contatos e fundos com detalhes sobre transações, pagamentos e fundos.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadados do conector | |
|---|---|
| Publicador | Troy Taylor, Hitachi Solutions |
| Site | https://givebutter.com/ |
| Política de privacidade | https://givebutter.com/privacy |
| Categorias | Finanças |
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | 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.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API (no formato 'Bearer APIKey') | secureString | A chave de API (no formato 'Bearer APIKey') para esta api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Arquivar um contato |
Exclui um contato. |
| Atualizar um contato |
Atualiza um contato específico. |
| Atualizar um fundo |
Atualiza um fundo específico. |
| Atualizar uma campanha |
Atualiza uma campanha existente. |
| Criar um contato |
Cria um novo contato. |
| Criar um fundo |
Cria um novo fundo. |
| Criar uma campanha |
Cria uma nova campanha. |
| Excluir um fundo |
Exclui um fundo específico. |
| Excluir um membro |
Exclui um membro de uma campanha. |
| Excluir uma campanha |
Exclui uma campanha específica |
| Obter campanhas |
Recupera uma lista de suas campanhas. |
| Obter contatos |
Recupera uma lista de contatos. |
| Obter equipes |
Recupera uma lista das equipes em uma campanha específica. |
| Obter fundos |
Recupera uma lista de fundos. |
| Obter membros |
Recupera uma lista dos membros de uma campanha específica. |
| Obter pagamentos |
Recupera uma lista de pagamentos |
| Obter planos |
Recupera uma lista de planos |
| Obter transações |
Recupera uma lista de transações |
| Obter tíquetes |
Recupere uma lista de seus tíquetes. |
| Obter um contato |
Recupera um contato específico. |
| Obter um fundo |
Recupera um fundo específico. |
| Obter um membro |
Recupera um membro específico. |
| Obter um pagamento |
Recupera um pagamento específico |
| Obter um plano |
Recupera um plano específico. |
| Obter um tíquete |
Recupera um tíquete específico. |
| Obter uma campanha |
Recupera uma campanha específica. |
| Obter uma equipe |
Recupera uma equipe específica. |
| Obter uma transação |
Recupera uma transação específica. |
| Restaurar um contato |
Restaura um contato excluído |
Arquivar um contato
Exclui um contato.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
O identificador exclusivo. |
Retornos
- response
- string
Atualizar um contato
Atualiza um contato específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
O identificador exclusivo. |
|
Primeiro Nome
|
first_name | string |
O nome. |
|
|
Nome do Meio
|
middle_name | string |
O nome do meio. |
|
|
Apelido
|
last_name | string |
O sobrenome. |
|
|
DOB
|
dob | string |
A data de nascimento. |
|
|
Empresa
|
company | string |
A empresa. |
|
|
Title
|
title | string |
O título. |
|
|
Twitter URL
|
twitter_url | string |
O endereço da URL do Twitter. |
|
|
LinkedIn URL
|
linkedin_url | string |
O endereço de URL do LinkedIn. |
|
|
Facebook URL
|
facebook_url | string |
O endereço da URL do Facebook. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador exclusivo. |
|
Primeiro Nome
|
first_name | string |
O nome. |
|
Nome do Meio
|
middle_name | string |
O nome do meio. |
|
Apelido
|
last_name | string |
O sobrenome. |
|
DOB
|
dob | string |
A data de nascimento. |
|
Empresa
|
company | string |
A empresa. |
|
Title
|
title | string |
O título. |
|
Twitter URL
|
twitter_url | string |
O endereço da URL do Twitter. |
|
LinkedIn URL
|
linkedin_url | string |
O endereço de URL do LinkedIn. |
|
Facebook URL
|
facebook_url | string |
O endereço da URL do Facebook. |
|
Emails
|
emails | array of object | |
|
Tipo
|
emails.type | string |
O tipo. |
|
Value
|
emails.value | string |
O valor. |
|
Telefones
|
phones | array of object | |
|
Tipo
|
phones.type | string |
O tipo. |
|
Value
|
phones.value | string |
O valor. |
|
Email Primário
|
primary_email | string |
O endereço de email principal. |
|
Telefone Primário
|
primary_phone | string |
O número de telefone primário. |
|
Observação
|
note | string |
A anotação. |
|
Addresses
|
addresses | array of object | |
|
Endereço
|
addresses.address_1 | string |
O endereço. |
|
Linha de endereço 2
|
addresses.address_2 | string |
A linha de endereço 2. |
|
City
|
addresses.city | string |
A cidade. |
|
Estado
|
addresses.state | string |
O estado. |
|
Cepcódigo
|
addresses.zipcode | string |
O código zip. |
|
País
|
addresses.country | string |
O país. |
|
Tipo
|
addresses.type | string |
O tipo. |
|
É Primário
|
addresses.is_primary | integer |
O é primário. |
|
Criado em
|
addresses.created_at | string |
O criado em. |
|
Atualizado em
|
addresses.updated_at | string |
A última atualização em. |
|
Endereço
|
primary_address.address_1 | string |
O endereço. |
|
Linha de endereço 2
|
primary_address.address_2 | string |
A linha de endereço 2. |
|
City
|
primary_address.city | string |
A cidade. |
|
Estado
|
primary_address.state | string |
O estado. |
|
Cepcódigo
|
primary_address.zipcode | string |
O código zip. |
|
País
|
primary_address.country | string |
O país. |
|
Tipo
|
primary_address.type | string |
O tipo. |
|
É Primário
|
primary_address.is_primary | integer |
O é primário. |
|
Criado em
|
primary_address.created_at | string |
Quando criado em. |
|
Atualizado em
|
primary_address.updated_at | string |
Quando atualizado pela última vez em. |
|
Contribuições recorrentes
|
stats.recurring_contributions | integer |
O número de contribuições recorrentes. |
|
Total de Contribuições
|
stats.total_contributions | integer |
O número total de contribuições. |
|
Etiquetas
|
tags | array of string | |
|
Campos personalizados
|
custom_fields | array of | |
|
Arquivado em
|
archived_at | string |
Quando arquivado em. |
|
Criado em
|
created_at | string |
O criado em. |
|
Atualizado em
|
updated_at | string |
A última atualização em. |
Atualizar um fundo
Atualiza um fundo específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
O identificador exclusivo. |
|
Nome
|
name | string |
O nome. |
|
|
Code
|
code | string |
O código. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador exclusivo. |
|
Code
|
code | string |
O código. |
|
Nome
|
name | string |
O nome. |
|
Levantou
|
raised | integer |
O valor arrecadado. |
|
Apoiantes
|
supporters | integer |
O número de apoiadores. |
|
Criado em
|
created_at | string |
O criado em. |
|
Atualizado em
|
updated_at | string |
A última atualização em. |
Atualizar uma campanha
Atualiza uma campanha existente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
O identificador exclusivo. |
|
Description
|
description | string |
A descrição. |
|
|
Terminar em
|
end_at | string |
Quando o final estiver em. |
|
|
Goal
|
goal | string |
O objetivo. |
|
|
Subtítulo
|
subtitle | string |
O subtítulo. |
|
|
Slug
|
slug | string |
A lesma. |
|
|
Title
|
title | string |
O título. |
|
|
Tipo
|
type | string |
O tipo. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador exclusivo. |
|
AccountID
|
account_id | string |
O identificador exclusivo da conta. |
|
Tipo
|
type | string |
O tipo. |
|
Title
|
title | string |
O título. |
|
Subtítulo
|
subtitle | string |
O subtítulo. |
|
Description
|
description | string |
A descrição. |
|
Slug
|
slug | string |
A lesma. |
|
URL
|
url | string |
O endereço da URL. |
|
Goal
|
goal | integer |
O objetivo. |
|
Levantou
|
raised | integer |
O valor arrecadado. |
|
Doadores
|
donors | integer |
O número de doadores. |
|
Moeda
|
currency | string |
A moeda. |
|
Logotipo
|
logo | string |
O logotipo. |
|
Tipo
|
cover.type | string |
O tipo. |
|
URL
|
cover.url | string |
O endereço da URL. |
|
Source
|
cover.source | string |
A origem. |
|
Terminar em
|
end_at | string |
Quando o final estiver em. |
|
Criado em
|
created_at | string |
O criado em. |
|
Atualizado em
|
updated_at | string |
A última atualização em. |
Criar um contato
Cria um novo contato.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Primeiro Nome
|
first_name | string |
O nome. |
|
|
Nome do Meio
|
middle_name | string |
O nome do meio. |
|
|
Apelido
|
last_name | string |
O sobrenome. |
|
|
Value
|
value | string |
O valor. |
|
|
Tipo
|
type | string |
O tipo. |
|
|
Value
|
value | string |
O valor. |
|
|
Tipo
|
type | string |
O tipo. |
|
|
Endereço
|
address_1 | string |
O endereço. |
|
|
Linha de endereço 2
|
address_2 | string |
A linha de endereço 2. |
|
|
City
|
city | string |
A cidade. |
|
|
Estado
|
state | string |
O estado. |
|
|
Cepcódigo
|
zipcode | string |
O código zip. |
|
|
País
|
country | string |
O país. |
|
|
Etiquetas
|
tags | array of string | ||
|
DOB
|
dob | string |
A data de nascimento. |
|
|
Empresa
|
company | string |
A empresa. |
|
|
Title
|
title | string |
O título. |
|
|
Twitter URL
|
twitter_url | string |
O endereço da URL do Twitter. |
|
|
LinkedIn URL
|
linkedin_url | string |
O endereço de URL do LinkedIn. |
|
|
Facebook URL
|
facebook_url | string |
O endereço da URL do Facebook. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador exclusivo. |
|
Primeiro Nome
|
first_name | string |
O nome. |
|
Nome do Meio
|
middle_name | string |
O nome do meio. |
|
Apelido
|
last_name | string |
O sobrenome. |
|
DOB
|
dob | string |
A data de nascimento. |
|
Empresa
|
company | string |
A empresa. |
|
Title
|
title | string |
O título. |
|
Twitter URL
|
twitter_url | string |
O endereço da URL do Twitter. |
|
LinkedIn URL
|
linkedin_url | string |
O endereço de URL do LinkedIn. |
|
Facebook URL
|
facebook_url | string |
O endereço da URL do Facebook. |
|
Emails
|
emails | array of object | |
|
Tipo
|
emails.type | string |
O tipo. |
|
Value
|
emails.value | string |
O valor. |
|
Telefones
|
phones | array of object | |
|
Tipo
|
phones.type | string |
O tipo. |
|
Value
|
phones.value | string |
O valor. |
|
Email Primário
|
primary_email | string |
O endereço de email principal. |
|
Telefone Primário
|
primary_phone | string |
O número de telefone primário. |
|
Observação
|
note | string |
A anotação. |
|
Addresses
|
addresses | array of object | |
|
Endereço
|
addresses.address_1 | string |
O endereço. |
|
Linha de endereço 2
|
addresses.address_2 | string |
A linha de endereço 2. |
|
City
|
addresses.city | string |
A cidade. |
|
Estado
|
addresses.state | string |
O estado. |
|
Cepcódigo
|
addresses.zipcode | string |
O código zip. |
|
País
|
addresses.country | string |
O país. |
|
Tipo
|
addresses.type | string |
O tipo. |
|
É Primário
|
addresses.is_primary | integer |
O é primário. |
|
Criado em
|
addresses.created_at | string |
O criado em. |
|
Atualizado em
|
addresses.updated_at | string |
A última atualização em. |
|
Endereço
|
primary_address.address_1 | string |
O endereço. |
|
Linha de endereço 2
|
primary_address.address_2 | string |
A linha de endereço 2. |
|
City
|
primary_address.city | string |
A cidade. |
|
Estado
|
primary_address.state | string |
O estado. |
|
Cepcódigo
|
primary_address.zipcode | string |
O código zip. |
|
País
|
primary_address.country | string |
O país. |
|
Tipo
|
primary_address.type | string |
O tipo. |
|
É Primário
|
primary_address.is_primary | integer |
O é primário. |
|
Criado em
|
primary_address.created_at | string |
Quando criado em. |
|
Atualizado em
|
primary_address.updated_at | string |
Quando atualizado pela última vez em. |
|
Contribuições recorrentes
|
stats.recurring_contributions | integer |
O número de contribuições recorrentes. |
|
Total de Contribuições
|
stats.total_contributions | integer |
O número total de contribuições. |
|
Etiquetas
|
tags | array of string |
As marcas. |
|
Campos personalizados
|
custom_fields | array of |
Os campos personalizados. |
|
Arquivado em
|
archived_at | string |
Quando arquivado em. |
|
Criado em
|
created_at | string |
O criado em. |
|
Atualizado em
|
updated_at | string |
A última atualização em. |
Criar um fundo
Cria um novo fundo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
name | string |
O nome. |
|
|
Code
|
code | string |
O código. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador exclusivo. |
|
Code
|
code | string |
O código. |
|
Nome
|
name | string |
O nome. |
|
Levantou
|
raised | integer |
O valor arrecadado. |
|
Apoiantes
|
supporters | integer |
O número de apoiadores. |
|
Criado em
|
created_at | string |
O criado em. |
|
Atualizado em
|
updated_at | string |
A última atualização em. |
Criar uma campanha
Cria uma nova campanha.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Description
|
description | string |
A descrição. |
|
|
Terminar em
|
end_at | string |
Quando o final estiver em. |
|
|
Goal
|
goal | integer |
O objetivo. |
|
|
Subtítulo
|
subtitle | string |
O subtítulo. |
|
|
Slug
|
slug | string |
A lesma. |
|
|
Title
|
title | string |
O título. |
|
|
Tipo
|
type | string |
O tipo. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador exclusivo. |
|
AccountID
|
account_id | string |
O identificador exclusivo da conta. |
|
Tipo
|
type | string |
O tipo. |
|
Title
|
title | string |
O título. |
|
Subtítulo
|
subtitle | string |
O subtítulo. |
|
Description
|
description | string |
A descrição. |
|
Slug
|
slug | string |
A lesma. |
|
URL
|
url | string |
O endereço da URL. |
|
Goal
|
goal | integer |
O objetivo. |
|
Levantou
|
raised | integer |
O valor arrecadado. |
|
Doadores
|
donors | integer |
O número de doadores. |
|
Moeda
|
currency | string |
A moeda. |
|
Logotipo
|
logo | string |
O logotipo. |
|
Tipo
|
cover.type | string |
O tipo. |
|
URL
|
cover.url | string |
O endereço da URL. |
|
Source
|
cover.source | string |
A origem. |
|
Terminar em
|
end_at | string |
Quando o final estiver em. |
|
Criado em
|
created_at | string |
O criado em. |
|
Atualizado em
|
updated_at | string |
A última atualização em. |
Excluir um fundo
Exclui um fundo específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
O identificador exclusivo. |
Retornos
- response
- string
Excluir um membro
Exclui um membro de uma campanha.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
campaign_id | True | string |
O identificador exclusivo da campanha. |
|
ID do membro
|
member_id | True | string |
O identificador exclusivo do membro. |
Retornos
- response
- string
Excluir uma campanha
Exclui uma campanha específica
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
O identificador exclusivo. |
Retornos
- response
- string
Obter campanhas
Recupera uma lista de suas campanhas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Scope
|
scope | string |
O escopo. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Dados
|
data | array of object | |
|
ID
|
data.id | integer |
O identificador exclusivo. |
|
AccountID
|
data.account_id | string |
O identificador exclusivo da conta. |
|
Tipo
|
data.type | string |
O tipo. |
|
Title
|
data.title | string |
O título. |
|
Subtítulo
|
data.subtitle | string |
O subtítulo. |
|
Description
|
data.description | string |
A descrição. |
|
Slug
|
data.slug | string |
A lesma. |
|
URL
|
data.url | string |
O endereço da URL. |
|
Goal
|
data.goal | integer |
O objetivo. |
|
Levantou
|
data.raised | integer |
O valor arrecadado. |
|
Doadores
|
data.donors | integer |
O número de doadores. |
|
Moeda
|
data.currency | string |
A moeda. |
|
Logotipo
|
data.logo | string |
O logotipo. |
|
Tipo
|
data.cover.type | string |
O tipo. |
|
URL
|
data.cover.url | string |
O endereço da URL. |
|
Source
|
data.cover.source | string |
A origem. |
|
Terminar em
|
data.end_at | string |
Quando o final estiver em. |
|
Criado em
|
data.created_at | string |
O criado em. |
|
Atualizado em
|
data.updated_at | string |
A última atualização em. |
|
Title
|
data.event.title | string |
O título. |
|
Tipo
|
data.event.type | string |
O tipo. |
|
Nome do Local
|
data.event.location_name | string |
O nome do local. |
|
Endereço Formatado
|
data.event.address_formatted | string |
O endereço formatado. |
|
Google Place ID
|
data.event.google_place_id | string |
O identificador exclusivo do Google Place. |
|
Iniciar em
|
data.event.start_at | string |
Quando o início estiver em. |
|
Terminar em
|
data.event.end_at | string |
O fim em. |
|
Timezone
|
data.event.timezone | string |
O fuso horário. |
|
Detalhes
|
data.event.details | string |
Os detalhes. |
|
Privado
|
data.event.private | boolean |
Seja particular. |
|
Tíquetes Necessários
|
data.event.tickets_required | boolean |
Se os tíquetes são necessários. |
|
URL
|
data.event.livestream.url | string |
O endereço da URL. |
|
Tipo
|
data.event.livestream.type | string |
O tipo. |
|
Localização
|
data.event.livestream.location | string |
O local. |
|
Platform
|
data.event.livestream.platform | string |
A plataforma. |
|
Inserir URL
|
data.event.livestream.embed_url | string |
O endereço de URL de inserção. |
|
Scheduled
|
data.event.livestream.scheduled | boolean |
Se agendado. |
|
Livestream Start At
|
data.event.livestream_start_at | string |
Quando a transmissão ao vivo começar. |
|
Fim da transmissão ao vivo em
|
data.event.livestream_end_at | string |
Quando a transmissão ao vivo terminar. |
|
First
|
links.first | string |
O primeiro. |
|
Last
|
links.last | string |
O último. |
|
Anterior
|
links.prev | string |
O anterior. |
|
Next
|
links.next | string |
A próxima. |
|
Página Atual
|
meta.current_page | integer |
A página atual. |
|
De
|
meta.from | integer |
O número de. |
|
Última Página
|
meta.last_page | integer |
O número da última página. |
|
Links
|
meta.links | array of object | |
|
URL
|
meta.links.url | string |
O endereço da URL. |
|
Etiqueta
|
meta.links.label | string |
O rótulo. |
|
Active
|
meta.links.active | boolean |
Se está ativo. |
|
Caminho
|
meta.path | string |
O caminho. |
|
Por Página
|
meta.per_page | integer |
O número por página. |
|
Para
|
meta.to | integer |
O número para. |
|
Total
|
meta.total | integer |
O número total. |
|
Total não filtrado
|
meta.unfiltered_total | integer |
O número total não filtrado. |
Obter contatos
Recupera uma lista de contatos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Scope
|
scope | string |
O escopo. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Dados
|
data | array of object | |
|
ID
|
data.id | integer |
O identificador exclusivo. |
|
Primeiro Nome
|
data.first_name | string |
O nome. |
|
Nome do Meio
|
data.middle_name | string |
O nome do meio. |
|
Apelido
|
data.last_name | string |
O sobrenome. |
|
DOB
|
data.dob | string |
A data de nascimento. |
|
Empresa
|
data.company | string |
A empresa. |
|
Title
|
data.title | string |
O título. |
|
Twitter URL
|
data.twitter_url | string |
O endereço da URL do Twitter. |
|
LinkedIn URL
|
data.linkedin_url | string |
O endereço de URL do LinkedIn. |
|
Facebook URL
|
data.facebook_url | string |
O endereço da URL do Facebook. |
|
Emails
|
data.emails | array of object | |
|
Tipo
|
data.emails.type | string |
O tipo. |
|
Value
|
data.emails.value | string |
O valor. |
|
Telefones
|
data.phones | array of object | |
|
Tipo
|
data.phones.type | string |
O tipo. |
|
Value
|
data.phones.value | string |
O valor. |
|
Email Primário
|
data.primary_email | string |
O endereço de email principal. |
|
Telefone Primário
|
data.primary_phone | string |
O número de telefone primário. |
|
Observação
|
data.note | string |
A anotação. |
|
Addresses
|
data.addresses | array of object | |
|
Endereço
|
data.addresses.address_1 | string |
O endereço. |
|
Linha de endereço 2
|
data.addresses.address_2 | string |
A linha de endereço 2. |
|
City
|
data.addresses.city | string |
A cidade. |
|
Estado
|
data.addresses.state | string |
O estado. |
|
Cepcódigo
|
data.addresses.zipcode | string |
O código zip. |
|
País
|
data.addresses.country | string |
O país. |
|
Tipo
|
data.addresses.type | string |
O tipo. |
|
É Primário
|
data.addresses.is_primary | integer |
O é primário. |
|
Criado em
|
data.addresses.created_at | string |
Quando criado em. |
|
Atualizado em
|
data.addresses.updated_at | string |
Quando atualizado pela última vez em. |
|
Endereço
|
data.primary_address.address_1 | string |
O endereço. |
|
Linha de endereço 2
|
data.primary_address.address_2 | string |
A linha de endereço 2. |
|
City
|
data.primary_address.city | string |
A cidade. |
|
Estado
|
data.primary_address.state | string |
O estado. |
|
Cepcódigo
|
data.primary_address.zipcode | string |
O código zip. |
|
País
|
data.primary_address.country | string |
O país. |
|
Tipo
|
data.primary_address.type | string |
O tipo. |
|
É Primário
|
data.primary_address.is_primary | integer |
O é primário. |
|
Criado em
|
data.primary_address.created_at | string |
Quando criado em. |
|
Atualizado em
|
data.primary_address.updated_at | string |
Quando atualizado em. |
|
Contribuições recorrentes
|
data.stats.recurring_contributions | integer |
O número de contribuições recorrentes. |
|
Total de Contribuições
|
data.stats.total_contributions | integer |
O número total de contribuições. |
|
Etiquetas
|
data.tags | array of string |
As marcas. |
|
Campos personalizados
|
data.custom_fields | array of |
Os campos personalizados. |
|
Arquivado em
|
data.archived_at | string |
Quando arquivado em. |
|
Criado em
|
data.created_at | string |
O criado em. |
|
Atualizado em
|
data.updated_at | string |
A última atualização em. |
|
First
|
links.first | string |
O primeiro. |
|
Last
|
links.last | string |
O último. |
|
Anterior
|
links.prev | string |
O anterior. |
|
Next
|
links.next | string |
A próxima. |
|
Página Atual
|
meta.current_page | integer |
A página atual. |
|
De
|
meta.from | integer |
O número de. |
|
Última Página
|
meta.last_page | integer |
O número da última página. |
|
Links
|
meta.links | array of object | |
|
URL
|
meta.links.url | string |
O endereço da URL. |
|
Etiqueta
|
meta.links.label | string |
O rótulo. |
|
Active
|
meta.links.active | boolean |
Se está ativo. |
|
Caminho
|
meta.path | string |
O caminho. |
|
Por Página
|
meta.per_page | integer |
O número por página. |
|
Para
|
meta.to | integer |
O número para. |
|
Total
|
meta.total | integer |
O número total. |
Obter equipes
Recupera uma lista das equipes em uma campanha específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
campaign_id | True | string |
O identificador exclusivo da campanha. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Dados
|
data | array of object | |
|
ID
|
data.id | integer |
O identificador exclusivo. |
|
Nome
|
data.name | string |
O nome. |
|
Logotipo
|
data.logo | string |
O logotipo. |
|
Slug
|
data.slug | string |
A lesma. |
|
URL
|
data.url | string |
O endereço da URL. |
|
Levantou
|
data.raised | integer |
O valor arrecadado. |
|
Goal
|
data.goal | integer |
O objetivo. |
|
Apoiantes
|
data.supporters | integer |
O número de apoiadores. |
|
Members
|
data.members | integer |
Os membros. |
|
First
|
links.first | string |
O primeiro. |
|
Last
|
links.last | string |
O último. |
|
Anterior
|
links.prev | string |
O anterior. |
|
Next
|
links.next | string |
A próxima. |
|
Página Atual
|
meta.current_page | integer |
A página atual. |
|
De
|
meta.from | integer |
O número de. |
|
Última Página
|
meta.last_page | integer |
O número da última página. |
|
Links
|
meta.links | array of object | |
|
URL
|
meta.links.url | string |
O endereço da URL. |
|
Etiqueta
|
meta.links.label | string |
O rótulo. |
|
Active
|
meta.links.active | boolean |
Se está ativo. |
|
Caminho
|
meta.path | string |
O caminho. |
|
Por Página
|
meta.per_page | integer |
O número por página. |
|
Para
|
meta.to | integer |
O número para. |
|
Total
|
meta.total | integer |
O número total. |
Obter fundos
Recupera uma lista de fundos.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Dados
|
data | array of object | |
|
ID
|
data.id | string |
O identificador exclusivo. |
|
Code
|
data.code | string |
O código. |
|
Nome
|
data.name | string |
O nome. |
|
Levantou
|
data.raised | float |
O valor arrecadado. |
|
Apoiantes
|
data.supporters | integer |
O número de apoiadores. |
|
Criado em
|
data.created_at | string |
O criado em. |
|
Atualizado em
|
data.updated_at | string |
A última atualização em. |
|
First
|
links.first | string |
O primeiro. |
|
Last
|
links.last | string |
O último. |
|
Anterior
|
links.prev | string |
O anterior. |
|
Next
|
links.next | string |
A próxima. |
|
Página Atual
|
meta.current_page | integer |
A página atual. |
|
De
|
meta.from | integer |
O número de. |
|
Última Página
|
meta.last_page | integer |
O número da última página. |
|
Links
|
meta.links | array of object | |
|
URL
|
meta.links.url | string |
O endereço da URL. |
|
Etiqueta
|
meta.links.label | string |
O rótulo. |
|
Active
|
meta.links.active | boolean |
Se está ativo. |
|
Caminho
|
meta.path | string |
O caminho. |
|
Por Página
|
meta.per_page | integer |
O número por página. |
|
Para
|
meta.to | integer |
O número para. |
|
Total
|
meta.total | integer |
O número total. |
Obter membros
Recupera uma lista dos membros de uma campanha específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
campaign_id | True | string |
O identificador exclusivo da campanha. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Dados
|
data | array of object | |
|
ID
|
data.id | integer |
O identificador exclusivo. |
|
Primeiro Nome
|
data.first_name | string |
O nome. |
|
Apelido
|
data.last_name | string |
O sobrenome. |
|
Email
|
data.email | string |
O endereço de email. |
|
Telefone
|
data.phone | string |
O número de telefone. |
|
Picture
|
data.picture | string |
A imagem. |
|
Levantou
|
data.raised | integer |
O valor arrecadado. |
|
Goal
|
data.goal | integer |
O objetivo. |
|
Doadores
|
data.donors | integer |
O número de doadores. |
|
Itens
|
data.items | integer |
O número de itens. |
|
URL
|
data.url | string |
O endereço da URL. |
|
First
|
links.first | string |
O primeiro. |
|
Last
|
links.last | string |
O último. |
|
Anterior
|
links.prev | string |
O anterior. |
|
Next
|
links.next | string |
A próxima. |
|
Página Atual
|
meta.current_page | integer |
A página atual. |
|
De
|
meta.from | integer |
O número de. |
|
Última Página
|
meta.last_page | integer |
O número da última página. |
|
Links
|
meta.links | array of object | |
|
URL
|
meta.links.url | string |
O endereço da URL. |
|
Etiqueta
|
meta.links.label | string |
O rótulo. |
|
Active
|
meta.links.active | boolean |
Se está ativo. |
|
Caminho
|
meta.path | string |
O caminho. |
|
Por Página
|
meta.per_page | integer |
O número por página. |
|
Para
|
meta.to | integer |
O número para. |
|
Total
|
meta.total | integer |
O número total. |
Obter pagamentos
Recupera uma lista de pagamentos
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Dados
|
data | array of object | |
|
ID
|
data.id | string |
O identificador exclusivo. |
|
ID da Campanha
|
data.campaign_id | integer |
O identificador exclusivo da campanha. |
|
Método
|
data.method | string |
O método. |
|
Situação
|
data.status | string |
O status. |
|
Quantidade
|
data.amount | integer |
O valor. |
|
Taxa
|
data.fee | integer |
A taxa. |
|
Dica
|
data.tip | integer |
A dica. |
|
Pagamento
|
data.payout | integer |
O pagamento. |
|
Moeda
|
data.currency | string |
A moeda. |
|
Endereço
|
data.address.address_1 | string |
O endereço. |
|
Linha de endereço 2
|
data.address.address_2 | string |
A linha de endereço 2. |
|
City
|
data.address.city | string |
A cidade. |
|
Estado
|
data.address.state | string |
O estado. |
|
Cepcódigo
|
data.address.zipcode | string |
O código zip. |
|
País
|
data.address.country | string |
O país. |
|
Memorando
|
data.memo | string |
O memorando. |
|
Concluído em
|
data.completed_at | string |
Quando concluído em. |
|
Criado em
|
data.created_at | string |
O criado em. |
|
First
|
links.first | string |
O primeiro. |
|
Last
|
links.last | string |
O último. |
|
Anterior
|
links.prev | string |
O anterior. |
|
Next
|
links.next | string |
A próxima. |
|
Página Atual
|
meta.current_page | integer |
A página atual. |
|
De
|
meta.from | integer |
O número de. |
|
Última Página
|
meta.last_page | integer |
O número da última página. |
|
Links
|
meta.links | array of object | |
|
URL
|
meta.links.url | string |
O endereço da URL. |
|
Etiqueta
|
meta.links.label | string |
O rótulo. |
|
Active
|
meta.links.active | boolean |
Se está ativo. |
|
Caminho
|
meta.path | string |
O caminho. |
|
Por Página
|
meta.per_page | integer |
O número por página. |
|
Para
|
meta.to | integer |
O número para. |
|
Total
|
meta.total | integer |
O número total. |
Obter planos
Recupera uma lista de planos
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Dados
|
data | array of object | |
|
ID
|
data.id | string |
O identificador exclusivo. |
|
Primeiro Nome
|
data.first_name | string |
O nome. |
|
Apelido
|
data.last_name | string |
O sobrenome. |
|
Email
|
data.email | string |
O endereço de email. |
|
Telefone
|
data.phone | string |
O número de telefone. |
|
Frequência
|
data.frequency | string |
A frequência. |
|
Situação
|
data.status | string |
O status. |
|
Método
|
data.method | string |
O método. |
|
Quantidade
|
data.amount | integer |
O valor. |
|
Taxa Coberta
|
data.fee_covered | float |
A taxa coberta. |
|
Criado em
|
data.created_at | string |
O criado em. |
|
Iniciar em
|
data.start_at | string |
Quando começou. |
|
Próxima Data de Cobrança
|
data.next_bill_date | string |
A próxima data da fatura. |
|
First
|
links.first | string |
O primeiro. |
|
Last
|
links.last | string |
O último. |
|
Anterior
|
links.prev | string |
O anterior. |
|
Next
|
links.next | string |
A próxima. |
|
Página Atual
|
meta.current_page | integer |
A página atual. |
|
De
|
meta.from | integer |
O número de. |
|
Última Página
|
meta.last_page | integer |
O número da última página. |
|
Links
|
meta.links | array of object | |
|
URL
|
meta.links.url | string |
O endereço da URL. |
|
Etiqueta
|
meta.links.label | string |
O rótulo. |
|
Active
|
meta.links.active | boolean |
Se está ativo. |
|
Caminho
|
meta.path | string |
O caminho. |
|
Por Página
|
meta.per_page | integer |
O número por página. |
|
Para
|
meta.to | integer |
O número para. |
|
Total
|
meta.total | integer |
O número total. |
Obter transações
Recupera uma lista de transações
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Dados
|
data | array of object | |
|
ID
|
data.id | string |
O identificador exclusivo. |
|
ID da Campanha
|
data.campaign_id | integer |
O identificador exclusivo da campanha. |
|
ID da equipe
|
data.team_id | string |
O identificador exclusivo da equipe. |
|
ID do membro
|
data.member_id | string |
O identificador exclusivo do membro. |
|
Primeiro Nome
|
data.first_name | string |
O nome. |
|
Apelido
|
data.last_name | string |
O sobrenome. |
|
Email
|
data.email | string |
O endereço de email. |
|
Telefone
|
data.phone | string |
O número de telefone. |
|
Endereço
|
data.address.address_1 | string |
O endereço. |
|
Linha de endereço 2
|
data.address.address_2 | string |
A linha de endereço 2. |
|
City
|
data.address.city | string |
A cidade. |
|
Estado
|
data.address.state | string |
O estado. |
|
Cepcódigo
|
data.address.zipcode | string |
O código zip. |
|
País
|
data.address.country | string |
O país. |
|
Situação
|
data.status | string |
O status. |
|
Método
|
data.method | string |
O método. |
|
Quantidade
|
data.amount | integer |
O valor. |
|
Taxa
|
data.fee | float |
A taxa. |
|
Taxa Coberta
|
data.fee_covered | float |
A taxa coberta. |
|
Doados
|
data.donated | integer |
O número doado. |
|
Pagamento
|
data.payout | integer |
O pagamento. |
|
Moeda
|
data.currency | string |
A moeda. |
|
Criado em
|
data.created_at | string |
O criado em. |
|
ID
|
data.giving_space.id | integer |
O identificador exclusivo. |
|
Nome
|
data.giving_space.name | string |
O nome. |
|
Quantidade
|
data.giving_space.amount | integer |
O valor. |
|
Message
|
data.giving_space.message | string |
A mensagem. |
|
Transactions
|
data.transactions | array of object | |
|
ID
|
data.transactions.id | string |
O identificador exclusivo. |
|
ID do Plano
|
data.transactions.plan_id | string |
O identificador exclusivo do plano. |
|
Quantidade
|
data.transactions.amount | integer |
O valor. |
|
Taxa
|
data.transactions.fee | float |
A taxa. |
|
Taxa Coberta
|
data.transactions.fee_covered | float |
A taxa coberta. |
|
Doados
|
data.transactions.donated | integer |
O número doado. |
|
Pagamento
|
data.transactions.payout | integer |
O pagamento. |
|
Capturado
|
data.transactions.captured | boolean |
Se capturado. |
|
Capturado em
|
data.transactions.captured_at | string |
O capturado em. |
|
Reembolsado
|
data.transactions.refunded | boolean |
Se reembolsado. |
|
Itens de Linha
|
data.transactions.line_items | array of object | |
|
Tipo
|
data.transactions.line_items.type | string |
O tipo. |
|
Subtipo
|
data.transactions.line_items.subtype | string |
O subtipo. |
|
Description
|
data.transactions.line_items.description | string |
A descrição. |
|
Quantidade
|
data.transactions.line_items.quantity | integer |
A quantidade. |
|
Preço
|
data.transactions.line_items.price | float |
O preço. |
|
Desconto
|
data.transactions.line_items.discount | integer |
O desconto. |
|
Total
|
data.transactions.line_items.total | float |
O total. |
|
First
|
links.first | string |
O primeiro. |
|
Last
|
links.last | string |
O último. |
|
Anterior
|
links.prev | string |
O anterior. |
|
Next
|
links.next | string |
A próxima. |
|
Página Atual
|
meta.current_page | integer |
A página atual. |
|
De
|
meta.from | integer |
O número de. |
|
Última Página
|
meta.last_page | integer |
O número da última página. |
|
Links
|
meta.links | array of object | |
|
URL
|
meta.links.url | string |
O endereço da URL. |
|
Etiqueta
|
meta.links.label | string |
O rótulo. |
|
Active
|
meta.links.active | boolean |
Se está ativo. |
|
Caminho
|
meta.path | string |
O caminho. |
|
Por Página
|
meta.per_page | integer |
O número por página. |
|
Para
|
meta.to | integer |
O número para. |
|
Total
|
meta.total | integer |
O número total. |
Obter tíquetes
Recupere uma lista de seus tíquetes.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Dados
|
data | array of object | |
|
ID
|
data.id | string |
O identificador exclusivo. |
|
Sufixo de ID
|
data.id_suffix | string |
O sufixo de ID. |
|
Nome
|
data.name | string |
O nome. |
|
Primeiro Nome
|
data.first_name | string |
O nome. |
|
Apelido
|
data.last_name | string |
O sobrenome. |
|
Email
|
data.email | string |
O endereço de email. |
|
Telefone
|
data.phone | string |
O número de telefone. |
|
Title
|
data.title | string |
O título. |
|
Description
|
data.description | string |
A descrição. |
|
Preço
|
data.price | integer |
O preço. |
|
PDF
|
data.pdf | string |
O PDF. |
|
Chegou em
|
data.arrived_at | string |
Quando chegou. |
|
Criado em
|
data.created_at | string |
O criado em. |
|
First
|
links.first | string |
O primeiro. |
|
Last
|
links.last | string |
O último. |
|
Anterior
|
links.prev | string |
O anterior. |
|
Next
|
links.next | string |
A próxima. |
|
Página Atual
|
meta.current_page | integer |
A página atual. |
|
De
|
meta.from | integer |
O número de. |
|
Última Página
|
meta.last_page | integer |
O número da última página. |
|
Links
|
meta.links | array of object | |
|
URL
|
meta.links.url | string |
O endereço da URL. |
|
Etiqueta
|
meta.links.label | string |
O rótulo. |
|
Active
|
meta.links.active | boolean |
Se está ativo. |
|
Caminho
|
meta.path | string |
O caminho. |
|
Por Página
|
meta.per_page | integer |
O número por página. |
|
Para
|
meta.to | integer |
O número para. |
|
Total
|
meta.total | integer |
O número total. |
Obter um contato
Recupera um contato específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
O identificador exclusivo. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador exclusivo. |
|
Primeiro Nome
|
first_name | string |
O nome. |
|
Nome do Meio
|
middle_name | string |
O nome do meio. |
|
Apelido
|
last_name | string |
O sobrenome. |
|
DOB
|
dob | string |
A data de nascimento. |
|
Empresa
|
company | string |
A empresa. |
|
Title
|
title | string |
O título. |
|
Twitter URL
|
twitter_url | string |
O endereço da URL do Twitter. |
|
LinkedIn URL
|
linkedin_url | string |
O endereço de URL do LinkedIn. |
|
Facebook URL
|
facebook_url | string |
O endereço da URL do Facebook. |
|
Emails
|
emails | array of object | |
|
Tipo
|
emails.type | string |
O tipo. |
|
Value
|
emails.value | string |
O valor. |
|
Telefones
|
phones | array of object | |
|
Tipo
|
phones.type | string |
O tipo. |
|
Value
|
phones.value | string |
O valor. |
|
Email Primário
|
primary_email | string |
O endereço de email principal. |
|
Telefone Primário
|
primary_phone | string |
O número de telefone primário. |
|
Observação
|
note | string |
A anotação. |
|
Addresses
|
addresses | array of object | |
|
Endereço
|
addresses.address_1 | string |
O endereço. |
|
Linha de endereço 2
|
addresses.address_2 | string |
A linha de endereço 2. |
|
City
|
addresses.city | string |
A cidade. |
|
Estado
|
addresses.state | string |
O estado. |
|
Cepcódigo
|
addresses.zipcode | string |
O código zip. |
|
País
|
addresses.country | string |
O país. |
|
Tipo
|
addresses.type | string |
O tipo. |
|
É Primário
|
addresses.is_primary | integer |
O é primário. |
|
Criado em
|
addresses.created_at | string |
O criado em. |
|
Atualizado em
|
addresses.updated_at | string |
A última atualização em. |
|
Endereço
|
primary_address.address_1 | string |
O endereço. |
|
Linha de endereço 2
|
primary_address.address_2 | string |
A linha de endereço 2. |
|
City
|
primary_address.city | string |
A cidade. |
|
Estado
|
primary_address.state | string |
O estado. |
|
Cepcódigo
|
primary_address.zipcode | string |
O código zip. |
|
País
|
primary_address.country | string |
O país. |
|
Tipo
|
primary_address.type | string |
O tipo. |
|
É Primário
|
primary_address.is_primary | integer |
O é primário. |
|
Criado em
|
primary_address.created_at | string |
Quando criado em. |
|
Atualizado em
|
primary_address.updated_at | string |
Quando atualizado pela última vez em. |
|
Contribuições recorrentes
|
stats.recurring_contributions | integer |
O número de contribuições recorrentes. |
|
Total de Contribuições
|
stats.total_contributions | integer |
O número total de contribuições. |
|
Etiquetas
|
tags | array of string | |
|
Campos personalizados
|
custom_fields | array of | |
|
Arquivado em
|
archived_at | string |
Quando arquivado em. |
|
Criado em
|
created_at | string |
O criado em. |
|
Atualizado em
|
updated_at | string |
A última atualização em. |
Obter um fundo
Recupera um fundo específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
O identificador exclusivo. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador exclusivo. |
|
Code
|
code | string |
O código. |
|
Nome
|
name | string |
O nome. |
|
Levantou
|
raised | float |
O valor arrecadado. |
|
Apoiantes
|
supporters | integer |
O número de apoiadores. |
|
Criado em
|
created_at | string |
O criado em. |
|
Atualizado em
|
updated_at | string |
A última atualização em. |
Obter um membro
Recupera um membro específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
campaign_id | True | string |
O identificador exclusivo da campanha. |
|
ID do membro
|
member_id | True | string |
O identificador exclusivo do membro. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador exclusivo. |
|
Primeiro Nome
|
first_name | string |
O nome. |
|
Apelido
|
last_name | string |
O sobrenome. |
|
Email
|
string |
O endereço de email. |
|
|
Telefone
|
phone | string |
O número de telefone. |
|
Picture
|
picture | string |
A imagem. |
|
Levantou
|
raised | integer |
O valor arrecadado. |
|
Goal
|
goal | integer |
O objetivo. |
|
Doadores
|
donors | integer |
O número de doadores. |
|
Itens
|
items | integer |
O número de itens. |
|
URL
|
url | string |
O endereço da URL. |
Obter um pagamento
Recupera um pagamento específico
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
O identificador exclusivo. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador exclusivo. |
|
ID da Campanha
|
campaign_id | integer |
O identificador exclusivo da campanha. |
|
Método
|
method | string |
O método. |
|
Situação
|
status | string |
O status. |
|
Quantidade
|
amount | integer |
O valor. |
|
Taxa
|
fee | integer |
A taxa. |
|
Dica
|
tip | integer |
A dica. |
|
Pagamento
|
payout | integer |
O pagamento. |
|
Moeda
|
currency | string |
A moeda. |
|
Endereço
|
address.address_1 | string |
O endereço. |
|
Linha de endereço 2
|
address.address_2 | string |
A linha de endereço 2. |
|
City
|
address.city | string |
A cidade. |
|
Estado
|
address.state | string |
O estado. |
|
Cepcódigo
|
address.zipcode | string |
O código zip. |
|
País
|
address.country | string |
O país. |
|
Memorando
|
memo | string |
O memorando. |
|
Concluído em
|
completed_at | string |
Quando concluído em. |
|
Criado em
|
created_at | string |
O criado em. |
Obter um plano
Recupera um plano específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
O identificador exclusivo. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador exclusivo. |
|
Primeiro Nome
|
first_name | string |
O nome. |
|
Apelido
|
last_name | string |
O sobrenome. |
|
Email
|
string |
O endereço de email. |
|
|
Telefone
|
phone | string |
O número de telefone. |
|
Frequência
|
frequency | string |
A frequência. |
|
Situação
|
status | string |
O status. |
|
Método
|
method | string |
O método. |
|
Quantidade
|
amount | integer |
O valor. |
|
Taxa Coberta
|
fee_covered | float |
A taxa coberta. |
|
Criado em
|
created_at | string |
O criado em. |
|
Iniciar em
|
start_at | string |
Quando começou. |
|
Próxima Data de Cobrança
|
next_bill_date | string |
A próxima data da fatura. |
Obter um tíquete
Recupera um tíquete específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
O identificador exclusivo. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador exclusivo. |
|
Sufixo de ID
|
id_suffix | string |
O sufixo de ID. |
|
Nome
|
name | string |
O nome. |
|
Primeiro Nome
|
first_name | string |
O nome. |
|
Apelido
|
last_name | string |
O sobrenome. |
|
Email
|
string |
O endereço de email. |
|
|
Telefone
|
phone | string |
O número de telefone. |
|
Title
|
title | string |
O título. |
|
Description
|
description | string |
A descrição. |
|
Preço
|
price | integer |
O preço. |
|
PDF
|
string |
O PDF. |
|
|
Chegou em
|
arrived_at | string |
Quando chegou. |
|
Criado em
|
created_at | string |
O criado em. |
Obter uma campanha
Recupera uma campanha específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
O identificador exclusivo. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador exclusivo. |
|
AccountID
|
account_id | string |
O identificador exclusivo da conta. |
|
Tipo
|
type | string |
O tipo. |
|
Title
|
title | string |
O título. |
|
Subtítulo
|
subtitle | string |
O subtítulo. |
|
Description
|
description | string |
A descrição. |
|
Slug
|
slug | string |
A lesma. |
|
URL
|
url | string |
O endereço da URL. |
|
Goal
|
goal | integer |
O objetivo. |
|
Levantou
|
raised | integer |
O valor arrecadado. |
|
Doadores
|
donors | integer |
O número de doadores. |
|
Moeda
|
currency | string |
A moeda. |
|
Logotipo
|
logo | string |
O logotipo. |
|
Tipo
|
cover.type | string |
O tipo. |
|
URL
|
cover.url | string |
O endereço da URL. |
|
Source
|
cover.source | string |
A origem. |
|
Terminar em
|
end_at | string |
Quando o final estiver em. |
|
Criado em
|
created_at | string |
O criado em. |
|
Atualizado em
|
updated_at | string |
A última atualização em. |
|
Title
|
event.title | string |
O título. |
|
Tipo
|
event.type | string |
O tipo. |
|
Nome do Local
|
event.location_name | string |
O nome do local. |
|
Endereço Formatado
|
event.address_formatted | string |
O endereço formatado. |
|
Google Place ID
|
event.google_place_id | string |
O identificador exclusivo do Google Place. |
|
Iniciar em
|
event.start_at | string |
Quando começou. |
|
Terminar em
|
event.end_at | string |
O fim em. |
|
Timezone
|
event.timezone | string |
O fuso horário. |
|
Detalhes
|
event.details | string |
Os detalhes. |
|
Privado
|
event.private | boolean |
Seja particular. |
|
Tíquetes Necessários
|
event.tickets_required | boolean |
Se os tíquetes são necessários. |
|
URL
|
event.livestream.url | string |
O endereço da URL. |
|
Tipo
|
event.livestream.type | string |
O tipo. |
|
Localização
|
event.livestream.location | string |
O local. |
|
Platform
|
event.livestream.platform | string |
A plataforma. |
|
Inserir URL
|
event.livestream.embed_url | string |
O endereço de URL de inserção. |
|
Scheduled
|
event.livestream.scheduled | boolean |
Se agendado. |
|
Livestream Start At
|
event.livestream_start_at | string |
A transmissão ao vivo começa em. |
|
Fim da transmissão ao vivo em
|
event.livestream_end_at | string |
A transmissão ao vivo termina em. |
Obter uma equipe
Recupera uma equipe específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
campaign_id | True | string |
O identificador exclusivo da campanha. |
|
ID da equipe
|
team_id | True | string |
O identificador exclusivo da equipe. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador exclusivo. |
|
Nome
|
name | string |
O nome. |
|
Logotipo
|
logo | string |
O logotipo. |
|
Slug
|
slug | string |
A lesma. |
|
URL
|
url | string |
O endereço da URL. |
|
Levantou
|
raised | integer |
O valor arrecadado. |
|
Goal
|
goal | integer |
O objetivo. |
|
Apoiantes
|
supporters | integer |
O número de apoiadores. |
|
Members
|
members | integer |
O número de membros. |
Obter uma transação
Recupera uma transação específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
O identificador exclusivo. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador exclusivo. |
|
ID da Campanha
|
campaign_id | integer |
O identificador exclusivo da campanha. |
|
ID da equipe
|
team_id | string |
O identificador exclusivo da equipe. |
|
ID do membro
|
member_id | string |
O identificador exclusivo do membro. |
|
Primeiro Nome
|
first_name | string |
O nome. |
|
Apelido
|
last_name | string |
O sobrenome. |
|
Email
|
string |
O endereço de email. |
|
|
Telefone
|
phone | string |
O número de telefone. |
|
Endereço
|
address.address_1 | string |
O endereço. |
|
Linha de endereço 2
|
address.address_2 | string |
A linha de endereço 2. |
|
City
|
address.city | string |
A cidade. |
|
Estado
|
address.state | string |
O estado. |
|
Cepcódigo
|
address.zipcode | string |
O código zip. |
|
País
|
address.country | string |
O país. |
|
Situação
|
status | string |
O status. |
|
Método
|
method | string |
O método. |
|
Quantidade
|
amount | integer |
O valor. |
|
Taxa
|
fee | float |
A taxa. |
|
Taxa Coberta
|
fee_covered | float |
A taxa coberta. |
|
Doados
|
donated | integer |
O número doado. |
|
Pagamento
|
payout | integer |
O pagamento. |
|
Moeda
|
currency | string |
A moeda. |
|
Criado em
|
created_at | string |
O criado em. |
|
ID
|
giving_space.id | integer |
O identificador exclusivo. |
|
Nome
|
giving_space.name | string |
O nome. |
|
Quantidade
|
giving_space.amount | integer |
O valor. |
|
Message
|
giving_space.message | string |
A mensagem. |
|
Transactions
|
transactions | array of object | |
|
ID
|
transactions.id | string |
O identificador exclusivo. |
|
ID do Plano
|
transactions.plan_id | string |
O identificador exclusivo do plano. |
|
Quantidade
|
transactions.amount | integer |
O valor. |
|
Taxa
|
transactions.fee | float |
A taxa. |
|
Taxa Coberta
|
transactions.fee_covered | float |
A taxa coberta. |
|
Doados
|
transactions.donated | integer |
O número doado. |
|
Pagamento
|
transactions.payout | integer |
O pagamento. |
|
Capturado
|
transactions.captured | boolean |
Se capturado. |
|
Capturado em
|
transactions.captured_at | string |
Quando capturado em. |
|
Reembolsado
|
transactions.refunded | boolean |
Se reembolsado. |
|
Itens de Linha
|
transactions.line_items | array of object | |
|
Tipo
|
transactions.line_items.type | string |
O tipo. |
|
Subtipo
|
transactions.line_items.subtype | string |
O subtipo. |
|
Description
|
transactions.line_items.title | string |
A descrição. |
|
Quantidade
|
transactions.line_items.quantity | integer |
A quantidade. |
|
Preço
|
transactions.line_items.price | float |
O preço. |
|
Desconto
|
transactions.line_items.discount | integer |
O desconto. |
|
Total
|
transactions.line_items.total | float |
O total. |
Restaurar um contato
Restaura um contato excluído
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
O identificador exclusivo. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador exclusivo. |
|
Primeiro Nome
|
first_name | string |
O nome. |
|
Nome do Meio
|
middle_name | string |
O nome do meio. |
|
Apelido
|
last_name | string |
O sobrenome. |
|
DOB
|
dob | string |
A data de nascimento. |
|
Empresa
|
company | string |
A empresa. |
|
Title
|
title | string |
O título. |
|
Twitter URL
|
twitter_url | string |
O endereço da URL do Twitter. |
|
LinkedIn URL
|
linkedin_url | string |
O endereço de URL do LinkedIn. |
|
Facebook URL
|
facebook_url | string |
O endereço da URL do Facebook. |
|
Emails
|
emails | array of object | |
|
Tipo
|
emails.type | string |
O tipo. |
|
Value
|
emails.value | string |
O valor. |
|
Telefones
|
phones | array of object | |
|
Tipo
|
phones.type | string |
O tipo. |
|
Value
|
phones.value | string |
O valor. |
|
Email Primário
|
primary_email | string |
O endereço de email principal. |
|
Telefone Primário
|
primary_phone | string |
O número de telefone primário. |
|
Observação
|
note | string |
A anotação. |
|
Addresses
|
addresses | array of object | |
|
Endereço
|
addresses.address_1 | string |
O endereço. |
|
Linha de endereço 2
|
addresses.address_2 | string |
A linha de endereço 2. |
|
City
|
addresses.city | string |
A cidade. |
|
Estado
|
addresses.state | string |
O estado. |
|
Cepcódigo
|
addresses.zipcode | string |
O código zip. |
|
País
|
addresses.country | string |
O país. |
|
Tipo
|
addresses.type | string |
O tipo. |
|
É Primário
|
addresses.is_primary | integer |
O é primário. |
|
Criado em
|
addresses.created_at | string |
O criado em. |
|
Atualizado em
|
addresses.updated_at | string |
A última atualização em. |
|
Endereço
|
primary_address.address_1 | string |
O endereço. |
|
Linha de endereço 2
|
primary_address.address_2 | string |
A linha de endereço 2. |
|
City
|
primary_address.city | string |
A cidade. |
|
Estado
|
primary_address.state | string |
O estado. |
|
Cepcódigo
|
primary_address.zipcode | string |
O código zip. |
|
País
|
primary_address.country | string |
O país. |
|
Tipo
|
primary_address.type | string |
O tipo. |
|
É Primário
|
primary_address.is_primary | integer |
O é primário. |
|
Criado em
|
primary_address.created_at | string |
Quando criado em. |
|
Atualizado em
|
primary_address.updated_at | string |
Quando atualizado pela última vez em. |
|
Contribuições recorrentes
|
stats.recurring_contributions | integer |
O número de contribuições recorrentes. |
|
Total de Contribuições
|
stats.total_contributions | integer |
O número total de contribuições. |
|
Etiquetas
|
tags | array of string | |
|
Campos personalizados
|
custom_fields | array of | |
|
Arquivado em
|
archived_at | string |
Quando arquivado em. |
|
Criado em
|
created_at | string |
O criado em. |
|
Atualizado em
|
updated_at | string |
A última atualização em. |
Definições
cadeia
Esse é o tipo de dados básico 'string'.