Skip to main content

List Groups

Returns a list of Groups belonging to your account.



Response Headers

  • X-PaginationLimit string

    The per page limit. Currently set to 100 but subject to change at any time.

  • X-Pagination-Current-Page string

    The current page. Defaults to 1.

  • X-Pagination-Total-Pages string

    The total number of pages in the result set. Use this along with Pagination-Current-Page to determine if there are any remaining pages/records to be retrieved.

  • X-Pagination-Total-Count string

    The total number of records in the result set (across all pages).


  • id integer

    Possible values: >= 1

  • created_at date-time

    The date and time at which this record was created.

  • updated_at date-time

    The date and time at which this record was most recently updated.

  • name string

    The name of the Group.

  • default boolean

    Indicates whether this Group is the default Group.

  • parent_id NullableId

    Possible values: >= 1

  • ancestry string

    A pipe delimited list of ancestor Group IDs, starting with the root Group and ending with the immediate parent Group.