Skip to main content
GET
/
office
/
{id}
Obter escritório
curl --request GET \
  --url http://localhost:3001/office/{id} \
  --header 'X-JuriChat-Api-Key: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "email": "jsmith@example.com",
  "phoneNumber": "<string>",
  "isArchived": true,
  "archivedAt": "2023-11-07T05:31:56Z",
  "inOnboarding": true,
  "officeCredits": [
    {
      "id": "<string>",
      "name": "<string>",
      "balance": 123,
      "creditModuleId": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.jurichat.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-JuriChat-Api-Key
string
header
required

Chave de API do escritório (criada no painel). Envie o valor no header X-JuriChat-Api-Key.

Path Parameters

​
id
string
required
Pattern: ^[cC][^\s-]{8,}$

Response

Default Response

​
id
string
required

ID do escritório.

​
name
string
required

Nome do escritório.

​
email
string<email>
required

E-mail de contato do escritório.

​
phoneNumber
string | null
required

Telefone do escritório. Null se não informado.

​
isArchived
boolean | null
required

Indica se o escritório está arquivado.

​
archivedAt
string<date-time> | null
required

Data e hora em que o escritório foi arquivado. Null se não arquivado.

​
inOnboarding
boolean
required

Indica se o escritório está no fluxo de onboarding.

​
officeCredits
object[]
required

Créditos disponíveis por módulo no escritório.