API da conta

Referência de API Zurich

Release

zurich

ft:locale

pt-BR

ft:publication_title

Referência de API Zurich

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

API da conta

Versão de lançamento: Zurich

Atualizado 31 de jul. de 2025

14 min. de leitura

. Conta A API fornece endpoints para recuperar Customer Service Management (CSM) registros de conta.

Esta API requer o plug-in Atendimento ao cliente (com.sn_customerservice) e é fornecida no agora namespace.

Os usuários precisam da função csm_ws_integration para acesso total à API.

Conta - OBTER /now/account

Recupera um conjunto especificado de Customer Service Management (CSM) contas.

Formato de URL

URL com controle de versão: /api/now/api_version/account

URL padrão: /api/now/account

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho
Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, `v1` ou `v2` . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres

Tabela 2. Parâmetros de consulta
Nome	Descrição
sysparm_limit	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use sysparm_offsetparâmetro para paginar a recuperação de registro. Na resposta, o parâmetro booliano hasMoreretornado. Indica se há mais registros a serem retornados que atendem aos critérios de filtro. Tipo de dados: Número Padrão: 10
sysparm_offset	Índice de registro inicial para o qual começar a recuperar registros. Use este valor para paginar a recuperação de registro. Esta funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Por exemplo, na primeira vez que você chamar este endpoint, sysparm_offsetdefinido como "0". Para simplesmente percorrer todos os registros disponíveis, use `se você não tiver certeza de que você está usando o sysparm_offset` até chegar ao final de todos os registros. Não passe um número negativo em sysparm_offsetparâmetro. Tipo de dados: Número Padrão: 0
sysparm_query	Consulta codificada usada para filtrar o conjunto de resultados. Por exemplo: `Se você estiver usando o nome de usuário, o nome de usuário será usado para o nome de usuário` A consulta codificada é compatível ordenar por . Para classificar respostas com base em determinados campos, use ORDERBY e. ORDERBYDESC cláusulas em sysparm_query. Por exemplo, `SYsparm_query` filtra todos os registros ativos e ordena os resultados em ordem crescente por número primeiro e, em seguida, em ordem decrescente por categoria. Se parte da consulta for inválida, como especificar um nome de campo inválido, a instância ignorará a parte inválida. Em seguida, ele retorna linhas usando somente a parte válida da consulta. Você pode controlar esse comportamento usando a propriedade glide.invalid_query.returns_no_rows. Defina esta propriedade como verdadeira para não retornar linhas em uma consulta inválida. Nota: . glide.invalid_query.returns_no_rowsa propriedade controla o comportamento de todas as consultas na instância, como em listas, scripts ( GlideRecord.query() E APIs de serviço web. Tipo de dados: Cadeia de caracteres

Tabela 3. Solicitar parâmetros do corpo (XML ou JSON)
Elemento	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

Tabela 4. Cabeçalhos da solicitação
Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 5. Cabeçalhos de resposta
Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 6. Códigos de status
Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta (JSON ou XML)


Parâmetro	Descrição
account_code	Combinação exclusiva de valores que uma aplicação usa para identificar previsões orçamentárias e planos orçamentários. Tipo de dados: Cadeia de caracteres Comprimento máximo: 255
account_parent	Sys_id da conta primária desta conta. Localizado na tabela Conta [customer_account]. Tipo de dados: Cadeia de caracteres
account_path	Caminho das contas primárias para as secundárias na hierarquia de contas. Tipo de dados: Cadeia de caracteres Comprimento máximo: 255
active_escalation	Sys_id da escalação ativa associada à conta. Tipo de dados: Cadeia de caracteres Tabela: Escalação [sn_customerservice_escalation]
apple_icon	Ícone para favoritos da página inicial do iPhone. Tipo de dados: Imagem
banner_image	Imagem da faixa que aparece no portal do cliente. Tipo de dados: Imagem
banner_image_light	Pequena imagem da faixa. Tipo de dados: Imagem
banner_text	Texto da faixa que aparece no portal do cliente. Tipo de dados: Cadeia de caracteres Comprimento máximo: 4 000
cidade	Cidade na qual reside a empresa associada a esta conta. Tipo de dados: Cadeia de caracteres Comprimento máximo: 50
contato	Sys_id de um registro de contato associado a esta conta. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user]
país	País no qual reside a empresa associada a esta conta. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40 Padrão: EUA
cliente	Sinalizador que indica se a conta é uma conta de cliente, em vez de uma conta de parceiro. Valores possíveis: Verdadeiro: Conta do cliente Falso: Conta do parceiro Tipo de dados: Booliano Padrão: falso
desconto	Desconto concedido à conta nas compras. Tipo de dados: Número Comprimento máximo: 15
fax_phone	Número de telefone de fax primário da empresa associada a esta conta. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
fiscal_year	Ano fiscal da empresa associada à conta. Tipo de dados: Cadeia de caracteres
lat_long_error	Diferença na localização real em comparação com as informações de latitude e longitude. Tipo de dados: Cadeia de caracteres Comprimento máximo: 1 000
latitude	Latitude da empresa associada a esta conta. Tipo de dados: Número (número de ponto flutuante) Comprimento máximo: 40
longitude	Longitude da empresa associada a esta conta. Tipo de dados: Número (número de ponto flutuante) Comprimento máximo: 40
manufacturer	Sinalizador que indica se a empresa associada a esta conta fabrica mercadorias. Valores possíveis: Verdadeiro: Fabrica bens Falso: Não fabrica mercadorias Tipo de dados: Booliano Padrão: falso
market_cap	Valor de mercado das ações negociadas publicamente da empresa associada. Tipo de dados: Número (moeda) Comprimento máximo: 20
nome	Nome da empresa associada a esta conta. Tipo de dados: Cadeia de caracteres Comprimento máximo: 80
anotações	Informações adicionais sobre a empresa. Tipo de dados: Cadeia de caracteres Comprimento máximo: 4 000
num_employees	Número de pessoas empregadas pela empresa. Tipo de dados: Número (inteiro) Comprimento máximo: 40
número	Número que identifica esta conta. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
primário	Sys_id da conta primária desta conta. Tipo de dados: Cadeia de caracteres Tabela: Empresa [core_company]
parceiro	Sinalizador que indica se a conta é de parceiro ou de cliente. Valores possíveis: Verdadeiro: Conta do parceiro Falso: Conta do cliente Tipo de dados: Booliano Padrão: falso
telefone	Número de telefone primário da empresa. Tipo de dados: Cadeia de caracteres
primary	Sinalizador que indica se esta é uma conta primária. Valores possíveis: Verdadeiro: Conta primária Falso: Conta secundária Tipo de dados: Booliano Padrão: falso
primary_contact	Sys_id do contato primário da conta. Tipo de dados: Cadeia de caracteres Tabela: Contato [customer_contact]
lucros	Informações de lucro inseridas para esta conta. Tipo de dados: Número (moeda) Comprimento máximo: 40
publicamente_traded	Sinalizador que indica se a empresa associada a esta conta é negociada publicamente na bolsa de valores. Valores possíveis: Verdadeiro: Negociado publicamente Falso: Empresa privada Tipo de dados: Booliano
rank_tier	Tipo de conta. Valores possíveis: lista de proibições outro estratégico tático valor Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
registration_code	Código exclusivo que os clientes usam ao solicitar um login no portal do cliente. Este código fornece um método para validar o cliente na empresa antes de conceder acesso. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
revenue_per_year	Receita produzida pela empresa associada a esta conta. Tipo de dados: Número (moeda) Comprimento máximo: 20
estado	Estado em que a empresa reside. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
stock_price	Preço do estoque da empresa. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
stock_symbol	Símbolo de ações da empresa. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
rua	Endereço da empresa. Tipo de dados: Cadeia de caracteres Comprimento máximo: 255
sys_class_name	Tabela que contém o registro da conta associada. Tipo de dados: Cadeia de caracteres
sys_created_by	Usuário que criou originalmente a conta. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
sys_created_on	Data e hora em que a conta foi criada originalmente. Tipo de dados: Cadeia de caracteres
sys_id	Sys_id para o registro da conta. Tipo de dados: Cadeia de caracteres
sys_mod_count	Número de vezes que as informações da conta foram atualizadas. Tipo de dados: Número (inteiro)
sys_updated_by	Usuário que modificou as informações da conta pela última vez. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
sys_updated_on	Data e hora em que as informações da conta foram atualizadas pela última vez. Tipo de dados: Cadeia de caracteres
tema	Sys_id do tema do portal do cliente usado por esta conta. Tipo de dados: Cadeia de caracteres Tabela: Tema [sys_ui_theme]
fornecedor	Sinalizador que indica se a empresa associada a esta conta é um fornecedor. Valores possíveis: Verdadeiro: Fornecedor Falso: Não é um fornecedor Tipo de dados: Booliano Padrão: falso
vendor_manager	Lista de sys_ids dos gerentes de fornecedor da conta. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user]
vendor_type	Lista de sys_ids do tipo de fornecedor, como aplicações, hardware, serviços ou software. Tipo de dados: Cadeia de caracteres Tabela: Tipo de fornecedor [vendor_type]
site	URL do site da empresa. Tipo de dados: Cadeia de caracteres Comprimento máximo: 1 024
zip	CEP da empresa. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40

Solicitação de curl

curl "https://instance.servicenow.com/api/now/account?sysparm_limit=2&sysparm_offset=2>;rel="next" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

{
"result": [
  {
   "banner_image_light": "",
   "country": "USA",
   "parent": "",
   "notes": "",
   "stock_symbol": "",
   "discount": "",
   "active_escalation": "",
   "sys_updated_on": "2019-01-03 19:37:55",
   "apple_icon": "",
   "number": "ACCT0000003",
    "sys_updated_by": "admin",
    "fiscal_year": "",
    "sys_created_on": "2018-12-23 05:25:17",
    "contact": "",
    "stock_price": "",
    "state": "",
    "banner_image": "",
    "sys_created_by": "admin",
    "longitude": "",
    "zip": "BR1 3QR",
    "profits": "0",
    "phone": "+44 20 8466 9992",
    "fax_phone": "",
    "name": "Boxeo EMEA",
    "banner_text": "",
    "account_code": "~~~~3",
    "primary": "false",
    "city": "Bromley",
    "latitude": "",
    "sys_class_name": "customer_account",
    "manufacturer": "false",
    "account_parent": "86837a386f0331003b3c498f5d3ee4ca",
    "sys_id": "3eedd08413651200042ab3173244b088",
    "market_cap": "0",
    "num_employees": "",
    "rank_tier": "",
    "street": "18 London Rd",
    "vendor": "false",
    "lat_long_error": "",
    "theme": "",
    "vendor_type": "",
    "website": "",
    "revenue_per_year": "0",
    "publicly_traded": "false",
    "sys_mod_count": "5",
    "sys_tags": "",
    "partner": "false",
    "registration_code": "BOXEO-EMEA",
    "vendor_manager": "",
    "account_path": "~~~~1/~~~~3",
    "primary_contact": "ff66c1254fb81200025ba3618110c76e",
    "customer": "true"
  },
  {
    "banner_image_light": "",
    "country": "USA",
    "parent": "",
    "notes": "",
    "stock_symbol": "",
    "discount": "",
    "active_escalation": "",
    "sys_updated_on": "2019-01-03 19:38:04",
    "apple_icon": "",
    "number": "ACCT0000004",
    "sys_updated_by": "admin",
    "fiscal_year": "",
    "sys_created_on": "2018-12-23 05:19:24",
    "contact": "",
    "stock_price": "",
    "state": "",
    "banner_image": "",
    "sys_created_by": "admin",
    "longitude": "",
    "zip": "V5L 2G4",
    "profits": "0",
    "phone": "+1 604-255-9797",
    "fax_phone": "",
    "name": "Boxeo Canada",
    "banner_text": "",
    "account_code": "~~~~4",
    "primary": "false",
    "city": "Vancouver",
    "latitude": "",
    "sys_class_name": "customer_account",
    "manufacturer": "false",
    "account_parent": "86837a386f0331003b3c498f5d3ee4ca",
    "sys_id": "609cd80413651200042ab3173244b03e",
    "market_cap": "0",
    "num_employees": "",
    "rank_tier": "",
    "street": "1362 Venables St,, BC V5L 2G4, Canada",
    "vendor": "false",
    "lat_long_error": "",
    "theme": "",
    "vendor_type": "",
    "website": "",
    "revenue_per_year": "0",
    "publicly_traded": "false",
    "sys_mod_count": "5",
    "sys_tags": "",
    "partner": "false",
    "registration_code": "BOXEO-CANADA",
    "vendor_manager": "",
    "account_path": "~~~~1/~~~~4",
    "primary_contact": "c07424a54f781200025ba3618110c746",
    "customer": "true"
  }
 ]
}

Conta - OBTENHA /now/account/

Recupera o especificado Customer Service Management (CSM) conta.