Developers
Ingresar a la plataforma

Listar proyectos

GET/api/public/v1/projects

Devuelve una página de proyectos de la empresa en formato HAL. Admite filtros por companyCode, text, name, uniqueCode, externalId, archived y enabled, y paginado. Si no se envía archived, sólo devuelve proyectos no archivados.

Autorización

apiKeyScheme
X-API-KEY<token>

En: header

Parámetros de consulta

page?integer

Número de página a devolver, comenzando en 0.

Formatoint32
size?integer

Cantidad de elementos por página (por defecto 20, máximo 500).

Formatoint32
sort?array<>

Criterios de ordenamiento del resultado.

Criterios de ordenamiento, enviados como sort[0].property y sort[0].direction (ASC o DESC). Sin ordenamiento explícito, el orden de los resultados no está garantizado.

property?string
direction?string

Valor en

  • "ASC"
  • "DESC"
excludeCount?boolean

Si es true, omite el cálculo del total de resultados para responder más rápido.

companyCode?string

Código de la empresa cuyos proyectos se desean listar.

text?string

Texto libre (coincidencia parcial) sobre el nombre y el identificador externo del proyecto.

name?array<string>

Filtra por nombre exacto de uno o más proyectos.

uniqueCode?array<string>

Filtra por código único (uniqueCode) de uno o más proyectos.

externalId?string

Filtra por identificador externo exacto del proyecto.

archived?boolean

Filtra por proyectos archivados (true) o no archivados (false). Si se omite, sólo devuelve proyectos no archivados.

enabled?boolean

Filtra por proyectos que pueden (true) o no (false) seleccionarse en gastos nuevos.

Cuerpo de la respuesta

application/vnd.hal+json

application/json

application/json

curl -X GET "https://example.com/api/public/v1/projects?companyCode=0590843e-1d92-4d51-82c6-4a22a6b8be82"
{  "_embedded": {    "projects": [      {        "deleted": true,        "uniqueCode": "0590843e-1d92-4d51-82c6-4a22a6b8be82",        "companyCode": "0590843e-1d92-4d51-82c6-4a22a6b8be82",        "lastModifiedDate": "2024-11-13T16:51:00.000Z",        "createdDate": "2024-11-13T16:51:00.000Z",        "createdBy": "string",        "externalId": "string",        "name": "Expansión regional",        "archived": true,        "enabled": true,        "leaderUniqueCode": "0590843e-1d92-4d51-82c6-4a22a6b8be82"      }    ]  },  "_links": {    "property1": {      "href": "string",      "hreflang": "string",      "title": "string",      "type": "string",      "deprecation": "string",      "profile": "string",      "name": "string",      "templated": true    },    "property2": {      "href": "string",      "hreflang": "string",      "title": "string",      "type": "string",      "deprecation": "string",      "profile": "string",      "name": "string",      "templated": true    }  },  "page": {    "size": 0,    "totalElements": 0,    "totalPages": 0,    "number": 0  }}