Saltar al contenido principal
Listar Organizaciones
curl --request GET \
  --url http://127.0.0.1:3000/v1/organizations \
  --header 'Content-Type: <content-type>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "legalName": "<string>",
      "parentOrganizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "doingBusinessAs": "<string>",
      "legalDocument": "<string>",
      "status": {
        "status": {
          "description": "<string>",
          "code": "<string>"
        }
      },
      "address": {
        "line1": "<string>",
        "line2": "<string>",
        "zipCode": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>"
      },
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "page": 123,
  "limit": 123
}

Headers

​
Content-Type
string
required

Tipo de medio del recurso. Debe ser <code>application/json</code>.

​
Authorization
string

Token de autorización. Este encabezado es obligatorio si tu entorno tiene habilitado el Access Manager.

​
X-Request-Id
string

Identificador único usado para rastrear y seguir cada solicitud.

Query Parameters

​
limit
string
required

Número máximo de elementos que se incluirán en la respuesta. Máximo: 100

​
start_date
string

Inicio del periodo que deseas recuperar. También debes incluir el end_date.

​
end_date
string

Fin del periodo que deseas recuperar. También debes incluir el start_date.

​
sort_order
string

Orden utilizado para clasificar los resultados.

​
page
string
required

Número de la página que deseas recuperar.

​
metadata.key
string

Metadatos que la entidad debe tener.

Response

Indica que la solicitud se realizó correctamente y que la respuesta contiene los datos esperados.

​
items
object[]
​
page
integer

Número de páginas devueltas.

​
limit
integer

Número máximo de elementos incluidos en la respuesta.