Obter grupo de empresas

Retorna um objeto CompanyGroup.

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id

string

required

• O ID do object

Query Parameters

expand

string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

fields

string[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Response

200 - application/json

Este objeto representa um grupo de empresas do seu negócio. Ele permite que você agrupe empresas e aplique configurações em lote.

id

string

Identificador exclusivo para o objeto.

name

string

Nome da grupo de empresas.

metadata

object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

createdAt

string

Data de criação do objeto

updatedAt

string

Data de alteração do objeto

deleted

boolean

default: false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.