Skip to content
/
List all usergroups

Kanbert (v1)

Download OpenAPI description
api.json
api.yaml
Languages
Servers
https://api.kanbert.com/api/v1

Users

Operations

Clients

Operations

Projects

Operations

Tasks

Operations
Webhooks

Task Comments

Operations
Webhooks

Efforts

Operations

Contacts

Operations

Companies

Operations
Webhooks

Offers

Operations

Outgoing Invoices

Operations

Payments

Operations

Usergroups & Teams

Operations

List all usergroups

Request

Required scopes: user_group:read

Security
http or oauth2
Query
sortstring

Available sorts are name, is_team.
You can sort by multiple options by separating them with a comma. To sort in descending order, use - sign in front of the sort, for example: -title.

Example: sort=sort=-created_at,title
includestring

Available includes are users. You can include multiple options by separating them with a comma.

page[size]integer

The number of results that will be returned per page.

Default 30
page[cursor]string

The cursor to start the pagination from.

filterstring

Allowed filter fields (with allowed operators):

FieldTypeOperators
namestringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
is_teambooleaneq, ne, neq, isnull, isnotnull, notnull

Filtering expression. Accepts either JSON (array/tree of conditions) or a readable string DSL.

You can check the full syntax at Docs Filtering section.

Special values:

  • me.id — current authenticated user id (usable on fields of type id). Example: id eq me.id
  • now — current date-time. Example: dueOn lt now
  • sow/eow — start/end of week. Examples: dueOn gt sow, dueOn lt eow
  • som/eom — start/end of month. Examples: dueOn gt som, dueOn lt eom
  • today — special date for today; with eq it expands to the whole day range. Example: dueOn eq today
  • today±Nd — relative day offset. Examples: today-30d, today+5d.
Example: filter=title contains "Acme" and (created_at >= "2024-01-01" or client.name contains "Corp")
curl -i -X GET \
  'https://api.kanbert.com/api/v1/user-group?sort=sort%3D-created_at%2Ctitle&include=string&page%5Bsize%5D=30&page%5Bcursor%5D=string&filter=title+contains+%22Acme%22+and+%28created_at+%3E%3D+%222024-01-01%22+or+client.name+contains+%22Corp%22%29' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The cursor paginated collection of UsergroupData

Bodyapplication/json
dataArray of objects(UsergroupData)required

The list of items

data[].​idstringrequired
data[].​external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

data[].​namestringrequired
data[].​is_teambooleanrequired

If true, this usergroup is shown as team

data[].​usersArray of objects(UserData)required
data[].​users[].​idstringrequired
data[].​users[].​first_namestringrequired
data[].​users[].​last_namestringrequired
data[].​users[].​emailstringrequired
data[].​users[].​typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
data[].​users[].​spaceobject(SpaceData)required
data[].​users[].​space.​idstringrequired
data[].​users[].​space.​namestringrequired
linksArray of stringsrequired
metaobjectrequired
meta.​pathstring or nullrequired

Base path for paginator generated URLs.

meta.​per_pageintegerrequired

Number of items shown per page.

meta.​next_cursorstring or nullrequired
meta.​next_cursor_urlstring or nullrequired
meta.​prev_cursorstring or nullrequired
meta.​prev_cursor_urlstring or nullrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "links": [
    "string"
  ],
  "meta": {
    "path": "string",
    "per_page": 0,
    "next_cursor": "string",
    "next_cursor_url": "string",
    "prev_cursor": "string",
    "prev_cursor_url": "string"
  }
}

Retrieve a usergroup

Request

Required scopes: user_group:read

Security
http or oauth2
Path
idintegerrequired
Query
find_bystring

The field to search by

Default "id"
Enum"id""external_id""shortcode"
originstring

Used if find_by=external_id by default it will use the integration slug

includestring

Available includes are users. You can include multiple options by separating them with a comma.

curl -i -X GET \
  'https://api.kanbert.com/api/v1/user-group/{id}?find_by=id&origin=string&include=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

UsergroupData

Bodyapplication/json
idstringrequired
external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

namestringrequired
is_teambooleanrequired

If true, this usergroup is shown as team

usersArray of objects(UserData)required
users[].​idstringrequired
users[].​first_namestringrequired
users[].​last_namestringrequired
users[].​emailstringrequired
users[].​typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
users[].​spaceobject(SpaceData)required
users[].​space.​idstringrequired
users[].​space.​namestringrequired
Response
application/json
{
  "id": "string",
  "external_id": "string",
  "name": "string",
  "is_team": true,
  "users": [
    { … }
  ]
}

Settings

Operations

Integration

Operations

Files

Operations

Custom Fields

Operations

Webhook Management

Operations

Schemas

Schemas