Groups
Authorizations
Query parameters
limitinteger · int32OptionalDefault:
100
namestring | nullableOptional
page_tokenstring | nullableOptional
Responses
200
OK
application/json
get
GET /api/admin/v1/groups HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
OK
{
"items": [
{
"id": "text",
"name": "text",
"source_id": "text",
"source_integration_id": "text",
"source_integration_name": "text"
}
],
"pagination": {
"next_page_token": "text"
}
}
Authorizations
Body
namestringRequired
Display name of the group
members_emailsstring[]Required
Email addresses to assign as members of the group
Responses
200
OK
application/json
post
POST /api/admin/v1/groups HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"name": "text",
"members_emails": [
"text"
]
}
200
OK
{
"id": "text",
"name": "text",
"source_id": "text",
"source_integration_id": "text",
"source_integration_name": "text"
}
Authorizations
Path parameters
idstringRequired
Responses
200
OK
application/json
get
GET /api/admin/v1/groups/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
OK
{
"id": "text",
"name": "text",
"source_id": "text",
"source_integration_id": "text",
"source_integration_name": "text"
}
Authorizations
Path parameters
idstringRequired
Query parameters
limitinteger · int32OptionalDefault:
100
page_tokenstring | nullableOptional
Responses
200
OK
application/json
get
GET /api/admin/v1/groups/{id}/members HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
OK
{
"items": [
{
"email": "text"
}
],
"pagination": {
"next_page_token": "text"
}
}
Authorizations
Path parameters
idstringRequired
Body
members_emailsstring[]Required
Email addresses to assign as members of the group
Responses
204
No Content
put
PUT /api/admin/v1/groups/{id}/members HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27
{
"members_emails": [
"text"
]
}
204
No Content
No content
Authorizations
Path parameters
idstringRequired
Body
namestringRequired
Display name of the group
Responses
200
OK
application/json
put
PUT /api/admin/v1/groups/{id}/name HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"name": "text"
}
200
OK
{
"id": "text",
"name": "text",
"source_id": "text",
"source_integration_id": "text",
"source_integration_name": "text"
}
Last updated
Was this helpful?