Return all Access Groups

GET 
/api/v1/access_groups

Return all Access Groups

Request

Query Parameters

include string

Include associations (delimited with comma). Available associations: users, businesses

page int32

Default value: 1

Page offset to fetch.

per_page int32

Default value: 20

Number of results to return per page.

Responses

200

Return all Access Groups

application/vnd.api+json

Schema

Schema

data

object[]

required

Array [

id stringrequired

type stringrequired

Possible values: [access_groups]

links

object

required

self stringrequired

attributes

object

required

name stringrequired

]

meta

object

required

total-count numberrequired

total-pages numberrequired

Example (from schema)

{
  "data": [
    {
      "id": "string",
      "type": "access_groups",
      "links": {
        "self": "string"
      },
      "attributes": {
        "name": "string"
      }
    }
  ],
  "meta": {
    "total-count": 0,
    "total-pages": 0
  }
}

Loading...