Pular para o conteúdo principal

Múltiplas organizações

Há casos em que o usuário em questão faz parte de mais de uma organização (workspace). Para esses casos, é necessário informar de qual organização deseja acessar os recursos.

Listando organizações

Para ver a lista de organizações em que o usuário está presente, faça a requisição:

GET https://apisx.assine.online/v1/organizations
{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Acme",
"logo": "https://cdn.sx.digital/logo.png",
"is_owner": true,
"updated_at": "2022-05-24T14:15:22Z",
"created_at": "2022-05-24T14:15:22Z",
"links": {
"self": "https://apisx.assine.online/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"links": {
"next": "https://apisx.assine.online//v1/organizations?page=2",
"prev": null,
"first": "https://apisx.assine.online//v1/organizations?page=1"
},
"meta": {
"current_page": 1,
"from": 1,
"path": "https://apisx.assine.online//v1/organizations",
"per_page": 15,
"to": 1
}
}

Trocando de organização

Para acessar os recursos da organização que deseja, você deve informar um header X-Organization no endpoint que deseja. Exemplo para listar os envelopes enviados de uma organização específica:

GET https://apisx.assine.online/v1/envelopes
Authorization: Bearer aG1hYyBhc2RmaXV5a2xzZGZhc2RmYXNkZmFzZGZhc2Q=
Accept: application/json
X-Organization: 497f6eca-6276-4993-bfeb-53cbbbba6f08

{
"data": [
{
"id": "96af23d1-34a2-40d1-903d-9d1d941ae12d",
"hashid": "KL234",
"state": "in-transit",
"title": "Contrato de aluguel",
"subject": "Contrato de aluguel",
"message": "",
"expire_at": null,
"created_at": "2022-05-24T14:15:22Z",
"updated_at": "2022-05-24T14:15:22Z",
"sender": {
"name": "John Doe",
"email": "john.doe@example.com",
"avatar": "https://cdn.sx.digital/avatar.png"
},
"triggers": []
}
],
"links": {
// ...
},
"meta": {
// ...
}
}