GET
/
v2
/
group
curl --request GET \
  --url https://api.sonderplan.com/v2/group \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 5693,
      "name": "Video Editors",
      "description": "Full schedule access, limited project access",
      "is_default": true,
      "members": [
        {
          "id": 4,
          "first_name": "Jane",
          "last_name": "Smith",
          "primary_email": "[email protected]"
        }
      ],
      "acl_schedule": "R-",
      "acl_project": "R-",
      "acl_task": "R-",
      "acl_finance": "R-",
      "acl_report": "R-",
      "acl_contact": "R-",
      "acl_admin": "R-",
      "acl_account": "R-",
      "created_id": 3,
      "created": 1388552400,
      "updated_id": 3,
      "updated": 1388552400
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

id
string

One or more (comma seperated) IDs of groups to retrieve

name
string

Perform a full text search for the group name

description
string

Perform a full text search for the group description

acl_schedule
enum<string>

Filter groups that match the permission for Schedule Module

Available options:
--,
R-,
RW
acl_project
enum<string>

Filter groups that match the permission for Project Module

Available options:
--,
R-,
RW
acl_task
enum<string>

Filter groups that match the permission for Task Module

Available options:
--,
R-,
RW
acl_finance
enum<string>

Filter groups that match the permission for Finance Module

Available options:
--,
R-,
RW
acl_report
enum<string>

Filter groups that match the permission for Report Module

Available options:
--,
R-,
RW
acl_contact
enum<string>

Filter groups that match the permission for Contact Module

Available options:
--,
R-,
RW
acl_admin
enum<string>

Filter groups that match the permission for Admin Module

Available options:
--,
R-,
RW
acl_account
enum<string>

Filter groups that match the permission for Account Module

Available options:
--,
R-,
RW
fields
string

Comma seperated list of fields you wish to return

page
integer

Specify the page of results you wish to return

limit
integer

The number of results returned per page. Default if not specified is 10

order_asc
string

Specify the field (with type of string or integer) you wish to order (ascending) the response with

order_desc
string

Specify the field (with type of string or integer) you wish to order (descending) the response with

filter_operator
enum<string>
default:OR

Specify if multiple filters should be combined with OR or AND logic

Available options:
OR,
AND

Response

200
application/json
Successful Operation
data
object[]

Standard group model that returns all properties by default

meta
object