API ReferenceDepartments
List operators in a department
Returns every operator assigned to a department in the authenticated organization.
GET
/api/departments/{id}/membersReturns every operator assigned to a department in the authenticated organization. Each item includes the membership, operator, and department IDs, plus the operator's display name, email, and status. The departments feature must be enabled.
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.
Path Parameters
id*string
Path parameter. Unique identifier of this resource.
Match
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Response Body
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", "operatorId": "11111111-1111-4111-8111-111111111111", "departmentId": "11111111-1111-4111-8111-111111111111", "displayName": "Example name", "email": "[email protected]", "status": "example" } ]}Request examples
curl
curl --request GET \
'https://api.convor.io/api/departments/11111111-1111-4111-8111-111111111111/members' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'JavaScript
const response = await fetch("https://api.convor.io/api/departments/11111111-1111-4111-8111-111111111111/members", {
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?