List departments for the selected project
Lists all-project departments and reusable definitions explicitly bound to the selected project.
/api/departmentsLists all-project departments and reusable definitions explicitly bound to the selected project.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
departments:read- Module
- Automation & API module (
api_access) - Organization and site scope
- Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
- Retry behavior
- Safe read: You can safely retry this read-only request after a transport failure. It does not change resource state.
Query Parameters
Query parameter. BCP 47 locale or language tag used for localized content.
1 <= length <= 35Query parameter. Search text.
length <= 200Query parameter. Sort. Allowed values: name, sites, members.
"name"Value in
- "name"
- "sites"
- "members"
Query parameter. Order. Allowed values: asc, desc.
"asc"Value in
- "asc"
- "desc"
Query parameter. One-based page number.
1 <= value <= 9007199254740991Query parameter. Maximum number of records to return.
1 <= value <= 100Header Parameters
DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "data": [ { "id": "11111111-1111-4111-8111-111111111111", "orgId": "11111111-1111-4111-8111-111111111111", "projectScope": "all", "projectIds": [ "11111111-1111-4111-8111-111111111111" ], "name": "Example name", "slug": "example-resource", "description": "example", "isDefault": true, "locale": "en", "fallbackUsed": true, "translations": [ { "id": "11111111-1111-4111-8111-111111111111", "locale": "en", "status": "draft", "sourceLocale": "en", "machineTranslatedAt": "2026-08-04T10:00:00.000Z", "reviewedAt": "2026-08-04T10:00:00.000Z", "reviewedBy": "example", "name": "Example name", "description": "example", "createdAt": "2026-08-04T10:00:00.000Z", "updatedAt": "2026-08-04T10:00:00.000Z" } ], "createdAt": "2026-08-04T10:00:00.000Z", "updatedAt": "2026-08-04T10:00:00.000Z" } ]}Request examples
curl
curl --request GET \
'https://api.convor.io/api/departments' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'JavaScript
const response = await fetch("https://api.convor.io/api/departments", {
method: "GET",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_..."
},
});
const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
? null
: contentType.includes("json")
? await response.json()
: contentType.startsWith("text/")
? await response.text()
: await response.blob();
if (!response.ok) {
const message = typeof data === "object" && data !== null
&& "error" in data && typeof data.error === "object"
&& data.error !== null && "message" in data.error
? String(data.error.message)
: "Convor API request failed (" + response.status + ")";
throw new Error(message);
}
console.log(data);Was this page helpful?