Aller au contenu

GET /v1/organizations

L’organisation est le sommet de la hiérarchie : chaque projet appartient à une organisation. Une clé API étant rattachée à une organisation, le parcours type suit cette hiérarchie : organisation → projets → stack / alertes / EOL.

GET /api/v1/organizations
Authorization: Bearer twa_votre_cle_ici

Retourne l’organisation rattachée à la clé (toujours un tableau d’un seul élément).

[
{
"id": "018e5678-abcd-7000-8000-000000000001",
"name": "ACME Corp",
"role": "OWNER",
"is_personal": false,
"created_at": "2024-05-02T09:00:00Z"
}
]
ChampTypeDescription
idstring (UUID)Identifiant de l’organisation — à utiliser dans /organizations/{id}/projects
namestringNom de l’organisation
rolestringToujours OWNER (la clé opère au niveau organisation)
is_personalbooleantrue pour une organisation personnelle
created_atstring (ISO 8601)Date de création

GET /api/v1/organizations/{org_id}/projects
Authorization: Bearer twa_votre_cle_ici

Retourne tous les projets de l’organisation (la clé donne un accès org-wide). org_id doit correspondre à l’organisation de la clé.

ParamètreTypeDescription
org_idUUIDIdentifiant de l’organisation
[
{
"id": "018e1234-abcd-7000-8000-000000000010",
"name": "Infrastructure prod",
"description": "Serveurs et dépendances en production",
"org_id": "018e5678-abcd-7000-8000-000000000001",
"is_default": true,
"created_at": "2024-03-15T10:22:00Z"
}
]
ChampTypeDescription
idstring (UUID)Identifiant du projet — à utiliser dans tous les endpoints /organizations/{org_id}/projects/{id}/...
namestringNom du projet
descriptionstring | nullDescription (null si non renseignée)
org_idstring (UUID) | nullOrganisation à laquelle le projet appartient
is_defaultbooleantrue pour le projet créé automatiquement à l’inscription
created_atstring (ISO 8601)Date de création
CodeDétailCause
404Organisation introuvableorg_id ne correspond pas à l’organisation de la clé

Parcourir toute la hiérarchie organisations → projets

Fenêtre de terminal
curl -s \
-H "Authorization: Bearer twa_votre_cle_ici" \
https://app.techwatchalert.com/api/v1/organizations \
| jq -r '.[].id' \
| while read ORG; do
curl -s \
-H "Authorization: Bearer twa_votre_cle_ici" \
"https://app.techwatchalert.com/api/v1/organizations/${ORG}/projects" \
| jq -r '.[] | "\(.name)\t\(.id)"'
done

Python — tous les projets, groupés par organisation

import httpx
BASE_URL = "https://app.techwatchalert.com/api/v1"
headers = {"Authorization": "Bearer twa_votre_cle_ici"}
orgs = httpx.get(f"{BASE_URL}/organizations", headers=headers).json()
projects_by_org = {
org["name"]: httpx.get(
f"{BASE_URL}/organizations/{org['id']}/projects", headers=headers
).json()
for org in orgs
}
for org_name, projects in projects_by_org.items():
print(org_name, "", [p["name"] for p in projects])