Group

A group is an organizational entity. Groups contain users and companies, and may be associated with a language. This resource is read-only.

---

Lists Groups

GET https://domain.com/api/v1/groups

Headers

Name	Type	Description
Authorization*	String	Bearer \
Content-Type*	String	application/vnd.api+json

Response — 200 OK

{
  "data": [
    {
      "type": "groups",
      "id": "<ID>",
      "attributes": {
        "name": "Group name",
        "is-active": 1
      },
      "relationships": {
        "users": {
          "links": {
            "related": "https://domain.com/api/v1/groups/<ID>/users",
            "self": "https://domain.com/api/v1/groups/<ID>/relationships/users"
          }
        },
        "companies": {
          "links": {
            "related": "https://domain.com/api/v1/groups/<ID>/companies",
            "self": "https://domain.com/api/v1/groups/<ID>/relationships/companies"
          }
        },
        "language": {
          "links": {
            "related": "https://domain.com/api/v1/groups/<ID>/language",
            "self": "https://domain.com/api/v1/groups/<ID>/relationships/language"
          }
        }
      },
      "links": {
        "self": "https://domain.com/api/v1/groups/<ID>"
      }
    }
  ],
  "meta": {
    "page": {
      "currentPage": 1,
      "from": 1,
      "lastPage": 1,
      "perPage": 20,
      "to": 1,
      "total": 1
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://domain.com/api/v1/groups?page[number]=1&page[size]=20",
    "last": "https://domain.com/api/v1/groups?page[number]=1&page[size]=20"
  }
}

Filters

Filter	Example
Name	/groups?filter[name]=Group name
ID	/groups?filter[id]=1,2,3

---

Get Group

GET https://domain.com/api/v1/groups/:id

Path Parameters

Name	Type	Description
id*	Number	Group ID

Headers

Name	Type	Description
Authorization*	String	Bearer \
Content-Type*	String	application/vnd.api+json

Response — 200 OK

{
  "data": {
    "type": "groups",
    "id": "<ID>",
    "attributes": {
      "name": "Group name",
      "is-active": 1
    },
    "relationships": {
      "users": {
        "links": {
          "related": "https://domain.com/api/v1/groups/<ID>/users",
          "self": "https://domain.com/api/v1/groups/<ID>/relationships/users"
        }
      },
      "companies": {
        "links": {
          "related": "https://domain.com/api/v1/groups/<ID>/companies",
          "self": "https://domain.com/api/v1/groups/<ID>/relationships/companies"
        }
      },
      "language": {
        "links": {
          "related": "https://domain.com/api/v1/groups/<ID>/language",
          "self": "https://domain.com/api/v1/groups/<ID>/relationships/language"
        }
      }
    },
    "links": {
      "self": "https://domain.com/api/v1/groups/<ID>"
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://domain.com/api/v1/groups/<ID>"
  }
}

Response — 404 Not Found

{
  "jsonapi": {
    "version": "1.0"
  },
  "errors": [
    {
      "status": "404",
      "title": "Not Found"
    }
  ]
}